[CostManagement]: Introduce new APIs of View and CheckNameAvailability by bgsky · Pull Request #5895 · Azure/azure-rest-api-specs

bgsky · 2019-05-08T22:47:37Z

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and have all been fixed in this PR.
The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
adding/removing APIs.
adding/removing properties.
adding/removing API-version.
adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Please follow the link to find more details on API review process.

…2019-03-01-preview to version 2019-04-01-preview

…bility

AutorestCI · 2019-05-08T22:48:20Z

Automation for azure-sdk-for-ruby

Encountered an unknown error: (azure-sdk-for-ruby)

Traceback (most recent call last):
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 33, in exception_to_github
    yield context
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 170, in rest_handle_action
    return rest_pull_close(body, restapi_repo, sdk_pr_target_repo, sdkbase, sdk_tag)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 185, in rest_pull_close
    rest_pr_management(rest_pr, sdk_pr_target_repo, sdk_tag, sdk_default_base)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github_handler.py", line 151, in rest_pr_management
    sdk_tag=sdk_tag
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/SwaggerToSdkNewCLI.py", line 254, in generate_sdk_from_git_object
    with manage_git_folder(gh_token, Path(temp_dir) / Path("rest"), branched_rest_api_id, pr_number=pr_number) as restapi_git_folder, \
  File "/usr/lib/python3.6/contextlib.py", line 81, in __enter__
    return next(self.gen)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 272, in manage_git_folder
    clone_to_path(gh_token, temp_dir, split_git_id[0], branch_or_commit=branch, pr_number=pr_number)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 212, in clone_to_path
    repo.git.checkout(branch_or_commit)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 548, in <lambda>
    return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 1014, in _call_process
    return self.execute(call, **exec_kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 825, in execute
    raise GitCommandError(command, status, stderr_value, stdout_value)
git.exc.GitCommandError: Cmd('git') failed due to: exit code(128)
  cmdline: git checkout 07e565f60a95d4ba88bf1ad534f9b4c15e5c4be7
  stderr: 'fatal: reference is not a tree: 07e565f60a95d4ba88bf1ad534f9b4c15e5c4be7'

AutorestCI · 2019-05-08T22:48:22Z

Automation for azure-sdk-for-js

Encountered an unknown error: (azure-sdk-for-js)

Traceback (most recent call last):
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 33, in exception_to_github
    yield context
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 170, in rest_handle_action
    return rest_pull_close(body, restapi_repo, sdk_pr_target_repo, sdkbase, sdk_tag)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 185, in rest_pull_close
    rest_pr_management(rest_pr, sdk_pr_target_repo, sdk_tag, sdk_default_base)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github_handler.py", line 151, in rest_pr_management
    sdk_tag=sdk_tag
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/SwaggerToSdkNewCLI.py", line 254, in generate_sdk_from_git_object
    with manage_git_folder(gh_token, Path(temp_dir) / Path("rest"), branched_rest_api_id, pr_number=pr_number) as restapi_git_folder, \
  File "/usr/lib/python3.6/contextlib.py", line 81, in __enter__
    return next(self.gen)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 272, in manage_git_folder
    clone_to_path(gh_token, temp_dir, split_git_id[0], branch_or_commit=branch, pr_number=pr_number)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 212, in clone_to_path
    repo.git.checkout(branch_or_commit)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 548, in <lambda>
    return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 1014, in _call_process
    return self.execute(call, **exec_kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 825, in execute
    raise GitCommandError(command, status, stderr_value, stdout_value)
git.exc.GitCommandError: Cmd('git') failed due to: exit code(128)
  cmdline: git checkout 07e565f60a95d4ba88bf1ad534f9b4c15e5c4be7
  stderr: 'fatal: reference is not a tree: 07e565f60a95d4ba88bf1ad534f9b4c15e5c4be7'

AutorestCI · 2019-05-08T22:48:23Z

Automation for azure-sdk-for-python

Encountered an unknown error: (azure-sdk-for-python)

Traceback (most recent call last):
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 33, in exception_to_github
    yield context
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 170, in rest_handle_action
    return rest_pull_close(body, restapi_repo, sdk_pr_target_repo, sdkbase, sdk_tag)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 185, in rest_pull_close
    rest_pr_management(rest_pr, sdk_pr_target_repo, sdk_tag, sdk_default_base)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github_handler.py", line 151, in rest_pr_management
    sdk_tag=sdk_tag
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/SwaggerToSdkNewCLI.py", line 254, in generate_sdk_from_git_object
    with manage_git_folder(gh_token, Path(temp_dir) / Path("rest"), branched_rest_api_id, pr_number=pr_number) as restapi_git_folder, \
  File "/usr/lib/python3.6/contextlib.py", line 81, in __enter__
    return next(self.gen)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 272, in manage_git_folder
    clone_to_path(gh_token, temp_dir, split_git_id[0], branch_or_commit=branch, pr_number=pr_number)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 212, in clone_to_path
    repo.git.checkout(branch_or_commit)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 548, in <lambda>
    return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 1014, in _call_process
    return self.execute(call, **exec_kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 825, in execute
    raise GitCommandError(command, status, stderr_value, stdout_value)
git.exc.GitCommandError: Cmd('git') failed due to: exit code(128)
  cmdline: git checkout 07e565f60a95d4ba88bf1ad534f9b4c15e5c4be7
  stderr: 'fatal: reference is not a tree: 07e565f60a95d4ba88bf1ad534f9b4c15e5c4be7'

AutorestCI · 2019-05-08T22:50:05Z

Automation for azure-sdk-for-go

Encountered an unknown error: (azure-sdk-for-go)

Traceback (most recent call last):
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 33, in exception_to_github
    yield context
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 170, in rest_handle_action
    return rest_pull_close(body, restapi_repo, sdk_pr_target_repo, sdkbase, sdk_tag)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 185, in rest_pull_close
    rest_pr_management(rest_pr, sdk_pr_target_repo, sdk_tag, sdk_default_base)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github_handler.py", line 151, in rest_pr_management
    sdk_tag=sdk_tag
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/SwaggerToSdkNewCLI.py", line 254, in generate_sdk_from_git_object
    with manage_git_folder(gh_token, Path(temp_dir) / Path("rest"), branched_rest_api_id, pr_number=pr_number) as restapi_git_folder, \
  File "/usr/lib/python3.6/contextlib.py", line 81, in __enter__
    return next(self.gen)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 272, in manage_git_folder
    clone_to_path(gh_token, temp_dir, split_git_id[0], branch_or_commit=branch, pr_number=pr_number)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 212, in clone_to_path
    repo.git.checkout(branch_or_commit)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 548, in <lambda>
    return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 1014, in _call_process
    return self.execute(call, **exec_kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 825, in execute
    raise GitCommandError(command, status, stderr_value, stdout_value)
git.exc.GitCommandError: Cmd('git') failed due to: exit code(128)
  cmdline: git checkout 07e565f60a95d4ba88bf1ad534f9b4c15e5c4be7
  stderr: 'fatal: reference is not a tree: 07e565f60a95d4ba88bf1ad534f9b4c15e5c4be7'

azuresdkci · 2019-05-08T23:10:43Z

Can one of the admins verify this patch?

AutorestCI · 2019-05-08T23:46:47Z

Automation for azure-sdk-for-java

Encountered an unknown error: (azure-sdk-for-java)

Traceback (most recent call last):
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 33, in exception_to_github
    yield context
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 170, in rest_handle_action
    return rest_pull_close(body, restapi_repo, sdk_pr_target_repo, sdkbase, sdk_tag)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 185, in rest_pull_close
    rest_pr_management(rest_pr, sdk_pr_target_repo, sdk_tag, sdk_default_base)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github_handler.py", line 151, in rest_pr_management
    sdk_tag=sdk_tag
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/SwaggerToSdkNewCLI.py", line 254, in generate_sdk_from_git_object
    with manage_git_folder(gh_token, Path(temp_dir) / Path("rest"), branched_rest_api_id, pr_number=pr_number) as restapi_git_folder, \
  File "/usr/lib/python3.6/contextlib.py", line 81, in __enter__
    return next(self.gen)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 272, in manage_git_folder
    clone_to_path(gh_token, temp_dir, split_git_id[0], branch_or_commit=branch, pr_number=pr_number)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 212, in clone_to_path
    repo.git.checkout(branch_or_commit)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 548, in <lambda>
    return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 1014, in _call_process
    return self.execute(call, **exec_kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 825, in execute
    raise GitCommandError(command, status, stderr_value, stdout_value)
git.exc.GitCommandError: Cmd('git') failed due to: exit code(128)
  cmdline: git checkout 07e565f60a95d4ba88bf1ad534f9b4c15e5c4be7
  stderr: 'fatal: reference is not a tree: 07e565f60a95d4ba88bf1ad534f9b4c15e5c4be7'

NelsonDaniel

@bgsky The PR is faling on semantic, ModelValidation, lintdiff and a couple of Sdks. You can check the failures here https://dev.azure.com/azure-sdk/public/_build/results?buildId=28664

Please make sure to go through the contribution list as well.

Also, if you haven't taken a look at our new onboarding experience at OpenAPIHub, it's a convenient way to create your PR when you're copying from an existing API version or when you're editing your existing specs. Thanks!

majastrz · 2019-05-09T01:19:59Z

      "200": {

DELETE requires the following responses:

200 with body of deleted resource if it existed
204 no content if the resource did not exist

Docs: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md#delete-resource

Refers to: specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json:2122 in edea17d. [](commit_id = edea17d, deletion_comment = False)

majastrz · 2019-05-09T01:21:01Z

},

Same response issue as with the other DELETE.

Refers to: specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json:2258 in 6f28a1a. [](commit_id = 6f28a1a, deletion_comment = False)

majastrz · 2019-05-09T01:21:25Z

},

Another instance of the delete response issue.

Refers to: specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json:2392 in 6f28a1a. [](commit_id = 6f28a1a, deletion_comment = False)

majastrz · 2019-05-09T01:24:01Z

    "value": {

Are you ever going to add paging? If yes, then you should add it to the swagger even if service doesn't support it yet. Makes it easier to add paging later.

Refers to: specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json:3854 in 6f28a1a. [](commit_id = 6f28a1a, deletion_comment = False)

majastrz

I added comments. Can you take a look?

nschonni

exteranl -> external

...ent/resource-manager/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json

flanakin · 2019-05-09T05:55:54Z

...ent/resource-manager/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json

+      "in": "path",
+      "required": true,
+      "type": "string",
+      "description": "The scope associated with view operations. This includes '/subscriptions/{subscriptionId}' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope.",


"The scope associated with view operations. Cost Management supports any scope above a subscription, from billing accounts and management groups down to subscriptions and resource groups. Learn more about scopes and how to obtain the resource ID for your scope at Understanding and working with scopes"

I realize Query, Dimensions, and possibly Exports don't use this today. I want to fix those, too. Bonus points if you can specify this once and have all of those other APIs use the same description. It's always the same across all APIs.

NelsonDaniel · 2019-05-10T20:51:49Z

@azuresdkci retest this please

...ent/resource-manager/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json

bgsky · 2019-05-10T23:32:58Z

@majastrz In case of deleting a resource type of view, we throw no content exception, as part of error response, instead of 204.

@NelsonDaniel Please review validation. Some model failures are from other resource types in previous version. I would like to keep PR focus on new APIs, and not break old ones. Please also refer to validation from OpenAPI Hub
https://portal.azure-devex-tools.com/app/branch/bgsky/azure-rest-api-specs/dev-cost-management-Microsoft.CostManagement-2019-04-01-preview...master

majastrz · 2019-05-10T23:37:51Z

@majastrz In case of deleting a resource type of view, we throw no content exception, as part of error response, instead of 204.

The required response code is 204 on DELETE where the resource doesn't exist. Otherwise, it should return 200 with the body of the resource that was successfully deleted. HTTP 204 is sometimes described as "No Content", so it's likely you're talking about the same thing. Please confirm.

bgsky · 2019-05-10T23:40:56Z

@majastrz We are talking about the same thing. We do not list response of 204 separately, as it is wrapped in defaulted error response.

ravbhatnagar · 2019-05-13T21:22:41Z

@bgsky @gahorowi - Cost management has a couple of PRs open to add new APIs/make changes to this RP. Budget APis are not present in this one and Views APIs are not present in the other PR. Can you please work with the owner of the APis in other PR and have a joint API review? It may be helpful to schedule an API review meeting to close on it quicker.
#5881

NelsonDaniel · 2019-05-14T17:25:40Z

Closing this PR. As per my conversation with @bgsky, a separate PR will be open with merged APIs as suggested by @ravbhatnagar

bgsky and others added 4 commits May 3, 2019 10:36

Adds base for updating Microsoft.CostManagement from version preview/…

edea17d

…2019-03-01-preview to version 2019-04-01-preview

Updates readme

eaf5436

Updates API version in new specs and examples

8058102

Introduce new preview version with APIs of view and check name availa…

9410577

…bility

azuresdkci assigned NelsonDaniel May 8, 2019

azuresdkci requested a review from NelsonDaniel May 8, 2019 22:48

Fix bugs on naming

df930b3

bgsky changed the title ~~Dev cost management microsoft.cost management 2019 04 01 preview~~ [CostManagement]: Introduce new APIs of View and CheckNameAvailability May 9, 2019

REDMOND\chanwan added 2 commits May 8, 2019 17:56

Fix bug on naming

5c5c328

Fix bug on naming

6f28a1a

NelsonDaniel reviewed May 9, 2019

View reviewed changes

majastrz added ARMChangesRequested WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 9, 2019

majastrz requested changes May 9, 2019

View reviewed changes

nschonni reviewed May 9, 2019

View reviewed changes