|
3 | 3 | "info": { |
4 | 4 | "title": "HashiCorp Consul Service (HCS)", |
5 | 5 | "description": "Azure Managed App API for HCS", |
6 | | - "version": "2020-11-02" |
| 6 | + "version": "2020-12-21" |
7 | 7 | }, |
8 | 8 | "schemes": [ |
9 | 9 | "https" |
|
848 | 848 | ] |
849 | 849 | } |
850 | 850 | }, |
| 851 | + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.CustomProviders/resourceProviders/public/listConsulUpgradeVersions": { |
| 852 | + "post": { |
| 853 | + "summary": "ListConsulUpgradeVersions is an API endpoint called by the hcs Azure CLI extension\nto retrieve the versions supported by the cluser in an upgrade scenario.", |
| 854 | + "operationId": "ListConsulUpgradeVersions", |
| 855 | + "responses": { |
| 856 | + "200": { |
| 857 | + "description": "Returned when made against a valid cluster.", |
| 858 | + "schema": { |
| 859 | + "$ref": "#/definitions/hashicorp.cloud.consulama.ama.ListConsulUpgradeVersionsResponse" |
| 860 | + } |
| 861 | + }, |
| 862 | + "400": { |
| 863 | + "description": "Returned when the request contained invalid data.", |
| 864 | + "schema": { |
| 865 | + "$ref": "#/definitions/google.rpc.Status" |
| 866 | + } |
| 867 | + }, |
| 868 | + "401": { |
| 869 | + "description": "Returned when the request did not contain a valid client certificate.", |
| 870 | + "schema": { |
| 871 | + "$ref": "#/definitions/google.rpc.Status" |
| 872 | + } |
| 873 | + }, |
| 874 | + "500": { |
| 875 | + "description": "Returned when there was an internal error.", |
| 876 | + "schema": { |
| 877 | + "$ref": "#/definitions/google.rpc.Status" |
| 878 | + } |
| 879 | + } |
| 880 | + }, |
| 881 | + "parameters": [ |
| 882 | + { |
| 883 | + "name": "subscriptionId", |
| 884 | + "description": "subscription_id is the ID of the Azure subscription the Consul cluster\nexists in. This is the customer's subscription ID.", |
| 885 | + "in": "path", |
| 886 | + "required": true, |
| 887 | + "type": "string" |
| 888 | + }, |
| 889 | + { |
| 890 | + "name": "resourceGroup", |
| 891 | + "description": "resource_group is the resource group in which the Consul cluster is\nrunning. This is the AMA instance's managed resource group.", |
| 892 | + "in": "path", |
| 893 | + "required": true, |
| 894 | + "type": "string" |
| 895 | + }, |
| 896 | + { |
| 897 | + "name": "body", |
| 898 | + "in": "body", |
| 899 | + "required": true, |
| 900 | + "schema": { |
| 901 | + "$ref": "#/definitions/hashicorp.cloud.consulama.ama.ListConsulUpgradeVersionsRequest" |
| 902 | + } |
| 903 | + } |
| 904 | + ], |
| 905 | + "tags": [ |
| 906 | + "ConsulAMAService" |
| 907 | + ] |
| 908 | + } |
| 909 | + }, |
851 | 910 | "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.CustomProviders/resourceProviders/public/listSnapshots": { |
852 | 911 | "post": { |
853 | 912 | "summary": "ListSnapshots is used to list snapshots for a Consul cluster", |
|
1333 | 1392 | "TRUE" |
1334 | 1393 | ], |
1335 | 1394 | "default": "FALSE", |
1336 | | - "title": "Boolean is an enum for handling true/false values as Azure swagger validation doesn't\nlike bools: \nhttps://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#r3018" |
| 1395 | + "title": "Boolean is an enum for handling true/false values as Azure swagger validation doesn't\nlike bools:\nhttps://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#r3018" |
1337 | 1396 | }, |
1338 | 1397 | "hashicorp.cloud.consulama.ama.ClusterMode": { |
1339 | 1398 | "type": "string", |
|
1446 | 1505 | "vnetName": { |
1447 | 1506 | "type": "string", |
1448 | 1507 | "description": "vnet_name is the name of the Azure Virtual Network the consul cluster\nis deployed in." |
| 1508 | + }, |
| 1509 | + "sourceChannel": { |
| 1510 | + "type": "string", |
| 1511 | + "description": "source_channel indicates which mechanism was used to create this cluster.\nThis typically should be: terraform-provider-hcs, azure-portal, hcs-cli.\nThis is synonymous to a user-agent." |
1449 | 1512 | } |
1450 | 1513 | }, |
1451 | 1514 | "description": "ClusterProperties contains properties the user selected when creating the\nmanaged app instance." |
|
1929 | 1992 | }, |
1930 | 1993 | "title": "See ConsulAMAService.ListCluster" |
1931 | 1994 | }, |
| 1995 | + "hashicorp.cloud.consulama.ama.ListConsulUpgradeVersionsRequest": { |
| 1996 | + "type": "object", |
| 1997 | + "properties": { |
| 1998 | + "subscriptionId": { |
| 1999 | + "type": "string", |
| 2000 | + "description": "subscription_id is the ID of the Azure subscription the Consul cluster\nexists in. This is the customer's subscription ID." |
| 2001 | + }, |
| 2002 | + "resourceGroup": { |
| 2003 | + "type": "string", |
| 2004 | + "description": "resource_group is the resource group in which the Consul cluster is\nrunning. This is the AMA instance's managed resource group." |
| 2005 | + } |
| 2006 | + }, |
| 2007 | + "title": "See ConsulAMAService.ListUpdateVersion" |
| 2008 | + }, |
| 2009 | + "hashicorp.cloud.consulama.ama.ListConsulUpgradeVersionsResponse": { |
| 2010 | + "type": "object", |
| 2011 | + "properties": { |
| 2012 | + "versions": { |
| 2013 | + "type": "array", |
| 2014 | + "items": { |
| 2015 | + "$ref": "#/definitions/hashicorp.cloud.consulama.ama.Version" |
| 2016 | + } |
| 2017 | + } |
| 2018 | + } |
| 2019 | + }, |
1932 | 2020 | "hashicorp.cloud.consulama.ama.ListSnapshotsRequest": { |
1933 | 2021 | "type": "object", |
1934 | 2022 | "properties": { |
|
2196 | 2284 | "update": { |
2197 | 2285 | "$ref": "#/definitions/hashicorp.cloud.consulama.ama.ClusterUpdate", |
2198 | 2286 | "description": "update contains the details of the Consul cluster to be updated." |
| 2287 | + }, |
| 2288 | + "sourceChannel": { |
| 2289 | + "type": "string", |
| 2290 | + "description": "source_channel indicates which mechanism was used to initiate an update\nof this cluster.\nThis typically should be: terraform-provider-hcs, azure-portal, hcs-cli." |
2199 | 2291 | } |
2200 | 2292 | }, |
2201 | 2293 | "title": "See ConsulAMAService.UpdateCluster" |
|
2209 | 2301 | } |
2210 | 2302 | }, |
2211 | 2303 | "title": "See ConsulAMAService.UpdateCluster" |
| 2304 | + }, |
| 2305 | + "hashicorp.cloud.consulama.ama.Version": { |
| 2306 | + "type": "object", |
| 2307 | + "properties": { |
| 2308 | + "version": { |
| 2309 | + "type": "string", |
| 2310 | + "description": "version is the string representation of the Consul version." |
| 2311 | + }, |
| 2312 | + "status": { |
| 2313 | + "$ref": "#/definitions/hashicorp.cloud.consulama.ama.Version.Status", |
| 2314 | + "description": "status defines the version availability." |
| 2315 | + } |
| 2316 | + }, |
| 2317 | + "description": "Version is a consul cluster version used in upgrade scenarios." |
| 2318 | + }, |
| 2319 | + "hashicorp.cloud.consulama.ama.Version.Status": { |
| 2320 | + "type": "string", |
| 2321 | + "enum": [ |
| 2322 | + "AVAILABLE", |
| 2323 | + "RECOMMENDED", |
| 2324 | + "PREVIEW" |
| 2325 | + ], |
| 2326 | + "default": "AVAILABLE", |
| 2327 | + "description": "Status defines the version availability metadata.\n\n - AVAILABLE: AVAILABLE represents a version that is generally available\nbut no longer the preferred/recommended version.\n - RECOMMENDED: RECOMMENDED represents a version that is generally available\nand recommended by HashiCorp.\n - PREVIEW: PREVIEW represents a version that is not generally available." |
2212 | 2328 | } |
2213 | 2329 | } |
2214 | 2330 | } |
0 commit comments