Skip to content

Creating Settings.json spec under preview #21723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Renhe Li (lirenhe) merged 4 commits into from
Jan 3, 2023
Merged

Creating Settings.json spec under preview #21723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
48f9281
Creating Settings.json spec under preview
thramu Dec 1, 2022
14f655f
Adding settings.json into readme.md
thramu Dec 1, 2022
09472d6
Prettier fix
thramu Dec 1, 2022
6aefc5c
Review comments
thramu Dec 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
313 changes: 313 additions & 0 deletions ...gement/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,313 @@
{
Comment thread
thramu marked this conversation as resolved.
"swagger": "2.0",
"info": {
"title": "CostManagementClient",
"version": "2022-10-01-preview"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow.",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/{scope}/providers/Microsoft.CostManagement/settings": {
"get": {
"tags": [
"Settings"
],
"operationId": "Settings_List",
"description": "List all cost management settings in the requested scope.",
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/cost-management/"
},
"x-ms-examples": {
"SettingsList": {
"$ref": "./examples/settingsList.json"
}
},
"parameters": [
{
"$ref": "#/parameters/scopeSettingParameter"
},
{
"$ref": "common-types.json#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/SettingsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "common-types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/{scope}/providers/Microsoft.CostManagement/settings/{type}": {
"put": {
"tags": [
"Settings"
],
"operationId": "Settings_CreateOrUpdateByScope",
"description": "Create or update a setting within the given scope.",
"x-ms-examples": {
"CreateOrUpdateSettingByScope": {
"$ref": "./examples/settings-createOrUpdate.json"
}
},
"parameters": [
{
"$ref": "#/parameters/scopeSettingParameter"
},
{
"$ref": "#/parameters/settingTypeParameter"
},
{
"$ref": "common-types.json#/parameters/apiVersionParameter"
},
{
"name": "setting",
"description": "Setting to be created or updated.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Setting"
}
}
],
"responses": {
"201": {
"description": "Setting Created.",
"schema": {
"$ref": "#/definitions/Setting"
}
},
"200": {
"description": "Setting Updated.",
"schema": {
"$ref": "#/definitions/Setting"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "common-types.json#/definitions/ErrorResponse"
}
}
}
},
"get": {
"tags": [
"Settings"
],
"operationId": "Settings_GetByScope",
"description": "Get the setting from the given scope by name.",
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/cost-management/"
},
"x-ms-examples": {
"SettingByScope": {
"$ref": "./examples/setting-get.json"
}
},
"parameters": [
{
"$ref": "#/parameters/scopeSettingParameter"
},
{
"$ref": "#/parameters/settingTypeParameter"
},
{
"$ref": "common-types.json#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/Setting"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "common-types.json#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "Settings_DeleteByScope",
"description": "Delete a setting within the given scope.",
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/cost-management/"
},
"x-ms-examples": {
"SettingDeleteByScope": {
"$ref": "./examples/setting-delete.json"
}
},
"parameters": [
{
"$ref": "#/parameters/scopeSettingParameter"
},
{
"$ref": "#/parameters/settingTypeParameter"
},
{
"$ref": "common-types.json#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded."
Comment thread
thramu marked this conversation as resolved.
},
"204": {
"description": "OK. The request has succeeded."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "common-types.json#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"Setting": {
"description": "Setting definition.",
"discriminator": "kind",
"type": "object",
"allOf": [
{
"$ref": "common-types.json#/definitions/ProxyResource"
}
],
"properties": {
"kind": {
"type": "string",
"description": "Specifies the kind of settings.",
"enum": [
"taginheritance"
],
"x-ms-enum": {
"name": "SettingsKind",
"modelAsString": true
}
}
},
"required": [
"kind"
]
},
"TagInheritanceSetting": {
"description": "Tag Inheritance Setting definition.",
"type": "object",
"x-ms-discriminator-value": "taginheritance",
"allOf": [
{
"$ref": "#/definitions/Setting"
}
],
"properties": {
"properties": {
Comment thread
thramu marked this conversation as resolved.
"$ref": "#/definitions/TagInheritanceProperties",
"title": "Tag Inheritance properties"
}
}
},
"SettingsListResult": {
"description": "Setting list result. It contains a list of settings.",
"type": "object",
"properties": {
"value": {
"description": "The list of settings.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/Setting"
}
}
}
},
"TagInheritanceProperties": {
"type": "object",
"description": "The properties of the tag inheritance setting.",
"required": [
"preferContainerTags"
],
"properties": {
"preferContainerTags": {
Comment thread
thramu marked this conversation as resolved.
"description": "Prefer Container tags to override container tags with resource tags in case of conflicts.",
"type": "boolean"
}
}
}
},
"parameters": {
"scopeSettingParameter": {
"name": "scope",
"in": "path",
"required": true,
"type": "string",
"description": "The scope associated with setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope.",
Comment thread
thramu marked this conversation as resolved.
"x-ms-parameter-location": "method"
},
"settingTypeParameter": {
"name": "type",
"in": "path",
"description": "Setting type.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method",
"enum": [
"taginheritance"
],
"x-ms-enum": {
"name": "SettingType",
"modelAsString": true,
"values": [
{
"value": "taginheritance",
"description": "Tag Inheritance Settings is to inherit user defined tags from container(subscription/resource group) to its respective resources.",
"name": "TagInheritance"
}
]
}
}
}
}
Loading