Skip to content
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.

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

Dev cost management microsoft.cost management 2020 08 01 preview #19677

Conversation

vibsridh
Copy link
Contributor

@vibsridh vibsridh commented Jul 5, 2022

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

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 5, 2022

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 4 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) new version base version
package-preview-2020-08 package-preview-2020-08(d158fca) default(main)

The following errors/warnings are introduced by current PR:

Rule Message
⚠️ R1003 - ListInOperationName Since operation 'InsightsGet' response has model definition 'x-ms-pageable', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L41
⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'InsightsModel'. Consider using the plural form of 'Insights' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L41
⚠️ R4014 - AllResourcesMustHaveGetOperation The resource 'Insights' does not have get operation, please add it.
Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L99
⚠️ R4024 - PreviewVersionOverOneYear The API version:2020-08-01-preview having been in a preview state over one year , please move it to GA or retire.
Location: Microsoft.CostManagement/preview/2020-08-01-preview/costmanagement.insights.json#L4
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 5 Warnings warning [Detail]
  • The following tags are being changed in this PR
    • "https://github.com/Azure/azure-rest-api-specs/blob/d158fca2e153c104225a6d3f21ee8c7b3aa8597e/specification/cost-management/resource-manager/readme.md#tag-package-preview-2020-08">cost-management/resource-manager/readme.md#package-preview-2020-08
The following errors/warnings are introduced by current PR:
Rule Message
⚠️ UnkownSecurityScheme "readme":"cost-management/resource-manager/readme.md",
"tag":"package-preview-2020-08",
"details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
AzureKey,
Anonymous"
⚠️ Modeler/MissingType "readme":"cost-management/resource-manager/readme.md",
"tag":"package-preview-2020-08",
"details":"The schema 'AlertProperties-details-resourceGroupFilterItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/AlertProperties-details-resourceGroupFilterItem"
⚠️ Modeler/MissingType "readme":"cost-management/resource-manager/readme.md",
"tag":"package-preview-2020-08",
"details":"The schema 'AlertProperties-details-resourceFilterItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/AlertProperties-details-resourceFilterItem"
⚠️ Modeler/MissingType "readme":"cost-management/resource-manager/readme.md",
"tag":"package-preview-2020-08",
"details":"The schema 'AlertProperties-details-meterFilterItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/AlertProperties-details-meterFilterItem"
⚠️ Modeler/MissingType "readme":"cost-management/resource-manager/readme.md",
"tag":"package-preview-2020-08",
"details":"The schema 'QueryProperties-rows-itemsItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/QueryProperties-rows-itemsItem"
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 5, 2022

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-go - armcostmanagement - 1.1.0
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-costmanagement - 3.0.0
️❌ azure-sdk-for-net failed [Detail]
  • Failed [Logs]Release - Generate from 064075f. SDK Automation 14.0.0
    warn	Skip initScript due to not configured
    command	sudo apt-get install -y dotnet-sdk-6.0
    command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/cost-management/resource-manager/readme.md
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] No usable version of the libssl was found
    cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
    cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
    cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
    error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
    warn	Skip package processing as generation is failed
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 064075f. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️armcostmanagement [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New const `CostDetailsMetricTypeActualCostCostDetailsMetricType`
    info	[Changelog] - New const `CostDetailsStatusTypeCompletedCostDetailsStatusType`
    info	[Changelog] - New const `CostDetailsStatusTypeFailedCostDetailsStatusType`
    info	[Changelog] - New const `CostDetailsDataFormatCSVCostDetailsDataFormat`
    info	[Changelog] - New const `CostDetailsMetricTypeAmortizedCostCostDetailsMetricType`
    info	[Changelog] - New const `CostDetailsStatusTypeNoDataFoundCostDetailsStatusType`
    info	[Changelog] - New function `PossibleCostDetailsMetricTypeValues() []CostDetailsMetricType`
    info	[Changelog] - New function `*GenerateCostDetailsReportClient.BeginGetOperationResults(context.Context, string, string, *GenerateCostDetailsReportClientBeginGetOperationResultsOptions) (*runtime.Poller[GenerateCostDetailsReportClientGetOperationResultsResponse], error)`
    info	[Changelog] - New function `PossibleCostDetailsStatusTypeValues() []CostDetailsStatusType`
    info	[Changelog] - New function `*GenerateCostDetailsReportClient.BeginCreateOperation(context.Context, string, GenerateCostDetailsReportRequestDefinition, *GenerateCostDetailsReportClientBeginCreateOperationOptions) (*runtime.Poller[GenerateCostDetailsReportClientCreateOperationResponse], error)`
    info	[Changelog] - New function `NewGenerateCostDetailsReportClient(azcore.TokenCredential, *arm.ClientOptions) (*GenerateCostDetailsReportClient, error)`
    info	[Changelog] - New function `PossibleCostDetailsDataFormatValues() []CostDetailsDataFormat`
    info	[Changelog] - New struct `BlobInfo`
    info	[Changelog] - New struct `CostDetailsOperationResults`
    info	[Changelog] - New struct `CostDetailsTimePeriod`
    info	[Changelog] - New struct `GenerateCostDetailsReportClient`
    info	[Changelog] - New struct `GenerateCostDetailsReportClientBeginCreateOperationOptions`
    info	[Changelog] - New struct `GenerateCostDetailsReportClientBeginGetOperationResultsOptions`
    info	[Changelog] - New struct `GenerateCostDetailsReportClientCreateOperationResponse`
    info	[Changelog] - New struct `GenerateCostDetailsReportClientGetOperationResultsResponse`
    info	[Changelog] - New struct `GenerateCostDetailsReportErrorResponse`
    info	[Changelog] - New struct `GenerateCostDetailsReportRequestDefinition`
    info	[Changelog] - New struct `ReportManifest`
    info	[Changelog] - New struct `RequestContext`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 36 additive change(s).
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 064075f. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
  • ️✔️track2_azure-mgmt-costmanagement [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added operation group GenerateCostDetailsReportOperations
    info	[Changelog]   - Added operation group GenerateDetailedCostReportOperationResultsOperations
    info	[Changelog]   - Added operation group GenerateDetailedCostReportOperationStatusOperations
    info	[Changelog]   - Added operation group GenerateDetailedCostReportOperations
    info	[Changelog]   - Model Alert has a new parameter e_tag
    info	[Changelog]   - Model AlertPropertiesDetails has a new parameter company_name
    info	[Changelog]   - Model AlertPropertiesDetails has a new parameter department_name
    info	[Changelog]   - Model AlertPropertiesDetails has a new parameter enrollment_end_date
    info	[Changelog]   - Model AlertPropertiesDetails has a new parameter enrollment_number
    info	[Changelog]   - Model AlertPropertiesDetails has a new parameter enrollment_start_date
    info	[Changelog]   - Model AlertPropertiesDetails has a new parameter invoicing_threshold
    info	[Changelog]   - Model CommonExportProperties has a new parameter next_run_time_estimate
    info	[Changelog]   - Model CommonExportProperties has a new parameter partition_data
    info	[Changelog]   - Model CommonExportProperties has a new parameter run_history
    info	[Changelog]   - Model Dimension has a new parameter e_tag
    info	[Changelog]   - Model Dimension has a new parameter location
    info	[Changelog]   - Model Dimension has a new parameter sku
    info	[Changelog]   - Model Export has a new parameter next_run_time_estimate
    info	[Changelog]   - Model Export has a new parameter partition_data
    info	[Changelog]   - Model Export has a new parameter run_history
    info	[Changelog]   - Model ExportDeliveryDestination has a new parameter sas_token
    info	[Changelog]   - Model ExportDeliveryDestination has a new parameter storage_account
    info	[Changelog]   - Model ExportExecution has a new parameter e_tag
    info	[Changelog]   - Model ExportExecution has a new parameter error
    info	[Changelog]   - Model ExportProperties has a new parameter next_run_time_estimate
    info	[Changelog]   - Model ExportProperties has a new parameter partition_data
    info	[Changelog]   - Model ExportProperties has a new parameter run_history
    info	[Changelog]   - Model Operation has a new parameter id
    info	[Changelog]   - Model OperationDisplay has a new parameter description
    info	[Changelog]   - Model Resource has a new parameter e_tag
    info	[Changelog]   - Model Resource has a new parameter location
    info	[Changelog]   - Model Resource has a new parameter sku
    info	[Changelog]
    info	[Changelog] **Breaking changes**
    info	[Changelog]
    info	[Changelog]   - Model Alert no longer has parameter tags
    info	[Changelog]   - Model ExportExecution no longer has parameter tags
    info	[Changelog]   - Model ReportConfigFilter no longer has parameter tag_key
    info	[Changelog]   - Model ReportConfigFilter no longer has parameter tag_value
    info	[Changelog]   - Operation ExportsOperations.get has a new parameter expand
    info	[Changelog]   - Operation ExportsOperations.list has a new parameter expand
    info	[Changelog]   - Removed operation group SettingsOperations
️❌ azure-resource-manager-schemas failed [Detail]
  • Failed [Logs]Release - Generate from 064075f. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh]  old lockfile
    cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
    cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
    cmderr	[initScript.sh] npm WARN old lockfile
    cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
    cmderr	[initScript.sh] npm WARN old lockfile
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    warn	No file changes detected after generation
  • cost-management/resource-manager [View full logs
️️✔️ azure-powershell succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 064075f. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
  • ️✔️Az.Cost [View full logs]  [Release SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @vibsridh Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @tadelesh
    Copy link
    Member

    tadelesh commented Jul 6, 2022

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @vibsridh
    Copy link
    Contributor Author

    vibsridh commented Jul 6, 2022

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @vibsridh
    Copy link
    Contributor Author

    vibsridh commented Jul 6, 2022

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @vibsridh
    Copy link
    Contributor Author

    vibsridh commented Jul 6, 2022

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-workflow-bot
    Copy link

    Hi @vibsridh, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @tadelesh
    Copy link
    Member

    tadelesh commented Aug 5, 2022

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @leni-msft
    Copy link
    Contributor

    @vibsridh The "SDK azure-resource-manager-schemas" check failed due to Unable to determine scope for resource types scheduledActions . Though not blocking this PR, it affects ARM Template schemas autogeneration for your Swagger. Suggest to submit PR to update the config here:
    https://github.com/Azure/azure-resource-manager-schemas/blob/1836296c227f3651161e6af71852f389c4890bd7/generator/autogenlist.ts#L253-L271

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants