Skip to content

Commit 85646b6

Browse files
poshettRheaHooda23
andauthored
Fixing APIs in 2023-02-01-preview (#23343)
* Base API Commit * Changing API version to 2023-02-01-preview * Adding new getOrganizationApiKey post API * Adding returnApiKey property in ElasticMonitorResource * Updating getOrganizationApiKey URI * Adding SubscriptionIdParameter in getOrganizationApiKey * Renaming ex to Organizations_GetApiKey * Updating description for UserApiKeyResponse * Updating examples * Updating readme.md * Updated Depolyment Info, added marketplace info * prettier check fixed * model validation fixed * validation fix * prettier fix * Increasing max length limit of companyName and business from 50 to 100 * Increasing companyName and business max length limits to 100 in all versions * Revert "Increasing companyName and business max length limits to 100 in all versions" This reverts commit c8977b6. * Revert "Increasing max length limit of companyName and business from 50 to 100" This reverts commit 7bd3547. * Updating summary for getOrganizationApiKey * Renaming "returnApiKey" to "generateApiKey" * Adding "x-ms-secret": true for apiKey * Updating getOrganizationApiKey API to /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/getOrganizationApiKey * Rearranging APIs * Adding "consumes" to getOrganizationApiKey * Changing case of emailId * Moving the API under paths * Updating User and Company related properties' max length limit to 64 * Adding Location in response header of LROs * Updating getOrganizationApiKey path * Updating getOrganizationApiKey Summary * Moving "generateApiKey" inside MonitorProperties * Updating getOrganizationApiKey path * Adding listElasticVersions API * Prettier check fix for ElasticVersions_Get * Fixing Prettier Check in ElasticVersions_Get Example file * updated description for schemas and parameters * updated description for schemas and parameters fix * Updating getOrganizationApiKey API name to listOrganizationApiKey * Adding x-ms-pageable in listOrganizationApiKey * Revert "Adding x-ms-pageable in listOrganizationApiKey" This reverts commit d5b0b5c. * Revert "Updating getOrganizationApiKey API name to listOrganizationApiKey" This reverts commit bfd1a05. * updated description for subscription Id in elasticVersions Api specification * prettier check fixed * updated listElasticVersions API * added description for regionName param and elasticversionlistresponse * updated API path and added region as query param * updated verb to noun in the api path * added x-ms-parameter-location 1 * updated the operationID for elasticVersions Api * updated the operationID for elasticVersions Api 1 * reverted x-ms-parameter-location from the subscriptionId parameter --------- Co-authored-by: Rhea Hooda <rheahooda@microsoft.com>
1 parent 7aa6a1a commit 85646b6

File tree

3 files changed

+89
-13
lines changed

3 files changed

+89
-13
lines changed

specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-02-01-preview/elastic.json

Lines changed: 71 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,52 @@
107107
}
108108
}
109109
},
110+
"/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/elasticVersions": {
111+
"get": {
112+
"tags": [
113+
"ElasticVersions"
114+
],
115+
"summary": "Get a list of available versions for a region.",
116+
"operationId": "ElasticVersions_List",
117+
"produces": [
118+
"application/json"
119+
],
120+
"parameters": [
121+
{
122+
"$ref": "#/parameters/ApiVersionParameter"
123+
},
124+
{
125+
"$ref": "#/parameters/SubscriptionIdParameter"
126+
},
127+
{
128+
"in": "query",
129+
"name": "region",
130+
"description": "Region where elastic deployment will take place.",
131+
"required": true,
132+
"type": "string"
133+
}
134+
],
135+
"responses": {
136+
"200": {
137+
"description": "Success",
138+
"schema": {
139+
"$ref": "#/definitions/ElasticVersionsListResponse"
140+
}
141+
},
142+
"default": {
143+
"description": "Default error response.",
144+
"schema": {
145+
"$ref": "#/definitions/ResourceProviderDefaultErrorResponse"
146+
}
147+
}
148+
},
149+
"x-ms-examples": {
150+
"ElasticVersions_List": {
151+
"$ref": "./examples/ElasticVersions_List.json"
152+
}
153+
}
154+
}
155+
},
110156
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors": {
111157
"get": {
112158
"tags": [
@@ -1371,7 +1417,7 @@
13711417
}
13721418
}
13731419
},
1374-
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/getOrganizationApiKey": {
1420+
"/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getOrganizationApiKey": {
13751421
"post": {
13761422
"tags": [
13771423
"ApiKey"
@@ -1391,9 +1437,6 @@
13911437
{
13921438
"$ref": "#/parameters/SubscriptionIdParameter"
13931439
},
1394-
{
1395-
"$ref": "#/parameters/ResourceGroupNameParameter"
1396-
},
13971440
{
13981441
"in": "body",
13991442
"name": "body",
@@ -1755,6 +1798,10 @@
17551798
"format": "int32",
17561799
"type": "integer",
17571800
"readOnly": true
1801+
},
1802+
"generateApiKey": {
1803+
"description": "Flag to determine if User API Key has to be generated and shared.",
1804+
"type": "boolean"
17581805
}
17591806
}
17601807
},
@@ -1825,11 +1872,6 @@
18251872
"description": "Identity properties of the monitor resource.",
18261873
"$ref": "#/definitions/IdentityProperties"
18271874
},
1828-
"generateApiKey": {
1829-
"description": "Flag to determine if User API Key has to be generated and shared.",
1830-
"type": "boolean",
1831-
"readOnly": true
1832-
},
18331875
"tags": {
18341876
"description": "The tags of the monitor resource.",
18351877
"type": "object",
@@ -1962,6 +2004,23 @@
19622004
}
19632005
}
19642006
},
2007+
"ElasticVersionsListResponse": {
2008+
"description": "List of elastic versions available in a region.",
2009+
"type": "object",
2010+
"properties": {
2011+
"value": {
2012+
"description": "Results of a list operation.",
2013+
"type": "array",
2014+
"items": {
2015+
"type": "string"
2016+
}
2017+
},
2018+
"nextLink": {
2019+
"description": "Link to the next set of results, if any.",
2020+
"type": "string"
2021+
}
2022+
}
2023+
},
19652024
"LogRules": {
19662025
"description": "Set of rules for sending logs for the Monitor resource.",
19672026
"type": "object",
@@ -2057,7 +2116,7 @@
20572116
"type": "object",
20582117
"properties": {
20592118
"marketplaceSubscription": {
2060-
"description": "Marketplace Subscription Id",
2119+
"description": "Marketplace Subscription",
20612120
"type": "object",
20622121
"properties": {
20632122
"id": {
@@ -2067,11 +2126,11 @@
20672126
}
20682127
},
20692128
"marketplaceName": {
2070-
"description": "Subscription Details: Marketplace SAAS Name",
2129+
"description": "Marketplace Subscription Details: SAAS Name",
20712130
"type": "string"
20722131
},
20732132
"marketplaceResourceId": {
2074-
"description": "Subscription Details: Marketplace Resource URI",
2133+
"description": "Marketplace Subscription Details: Resource URI",
20752134
"type": "string"
20762135
}
20772136
}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-02-01-preview",
4+
"region": "myregion",
5+
"subscriptionId": "00000000-0000-0000-0000-000000000000"
6+
},
7+
"responses": {
8+
"200": {
9+
"body": {
10+
"value": [
11+
"version1",
12+
"version2",
13+
"version3"
14+
]
15+
}
16+
}
17+
}
18+
}

specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-02-01-preview/examples/Organizations_GetApiKey.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"parameters": {
33
"api-version": "2023-02-01-preview",
44
"subscriptionId": "00000000-0000-0000-0000-000000000000",
5-
"resourceGroupName": "myResourceGroup",
65
"requestBody": {
76
"emailId": "myemail@outlook.com"
87
}

0 commit comments

Comments
 (0)