Skip to content

Microsoft.OperationalInsights: Preview version 2023-01-01-preview #28945

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

Closed
wants to merge 19 commits into from

Conversation

dulikvor
Copy link
Contributor

@dulikvor dulikvor commented May 2, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

dulikvor added 9 commits May 1, 2024 17:40
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2023-09-01 to preview/2023-01-01-preview.
Copy link

openapi-pipeline-app bot commented May 2, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR modified the suppressions for JavaScript SDK breaking changes (label: BreakingChange-JavaScript-Sdk-Suppression). Refer to step 3 in the PR workflow diagram.
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it. In addition, refer to step 4 in the PR workflow diagram

Copy link

openapi-pipeline-app bot commented May 2, 2024

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: 10 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-2023-01-preview package-2023-01-preview(0c34215) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ PreviewVersionOverOneYear The API version:2023-01-01-preview having been in a preview state over one year , please move it to GA or retire.
Location: Microsoft.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json#L6
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json#L37
RPC-Get-V1-11
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SummaryLogsModel'. Consider using the plural form of 'SummaryLogs' 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.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json#L47
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SummaryLogsModel'. Consider using the plural form of 'SummaryLogs' 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.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json#L92
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SummaryLogsModel'. Consider using the plural form of 'SummaryLogs' 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.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json#L174
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SummaryLogsModel'. Consider using the plural form of 'SummaryLogs' 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.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json#L217
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SummaryLogsModel'. Consider using the plural form of 'SummaryLogs' 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.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json#L276
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: SummaryLogsStop
Location: Microsoft.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json#L313
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SummaryLogsModel'. Consider using the plural form of 'SummaryLogs' 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.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json#L318
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json#L442
️⚠️Avocado: 1 Warnings warning [Detail]
Rule Message
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/operationalinsights/resource-manager/readme.md
tag: specification/operationalinsights/resource-manager/readme.md#tag-package-2023-09
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented May 2, 2024

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
Rule Message
RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=431469&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
"detail":"Run.ps1 failed with exit code 1 "
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from f42052aeedc7c566e794bf4f0f4e8bec688537cf. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  • ️✔️Azure.ResourceManager.OperationalInsights [Preview SDK Changes]
    • Azure.ResourceManager.OperationalInsights.1.3.0-alpha.20240528.1.nupkg
    info	[Changelog]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from f42052aeedc7c566e794bf4f0f4e8bec688537cf. 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
  • ️✔️sdk/resourcemanager/operationalinsights/armoperationalinsights [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Type of `Cluster.Identity` has been changed from `*Identity` to `*ManagedServiceIdentity`
    info	[Changelog] - Type of `ClusterPatch.Identity` has been changed from `*Identity` to `*ManagedServiceIdentity`
    info	[Changelog] - Operation `*TablesClient.Update` has been changed to LRO, use `*TablesClient.BeginUpdate` instead.
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New value `CapacityFiftyThousand`, `CapacityFourHundred`, `CapacityOneHundred`, `CapacityTenThousand`, `CapacityThreeHundred`, `CapacityTwentyFiveThousand`, `CapacityTwoHundred` added to enum type `Capacity`
    info	[Changelog] - New value `CapacityReservationLevelFiftyThousand`, `CapacityReservationLevelTenThousand`, `CapacityReservationLevelTwentyFiveThousand` added to enum type `CapacityReservationLevel`
    info	[Changelog] - New value `DataSourceTypeIngestion` added to enum type `DataSourceType`
    info	[Changelog] - New value `IdentityTypeApplication`, `IdentityTypeKey`, `IdentityTypeManagedIdentity`, `IdentityTypeUser` added to enum type `IdentityType`
    info	[Changelog] - New enum type `ColumnDataTypeHintEnum` with values `ColumnDataTypeHintEnumArmPath`, `ColumnDataTypeHintEnumGUID`, `ColumnDataTypeHintEnumIP`, `ColumnDataTypeHintEnumURI`
    info	[Changelog] - New enum type `ColumnTypeEnum` with values `ColumnTypeEnumBoolean`, `ColumnTypeEnumDateTime`, `ColumnTypeEnumDynamic`, `ColumnTypeEnumGUID`, `ColumnTypeEnumInt`, `ColumnTypeEnumLong`, `ColumnTypeEnumReal`, `ColumnTypeEnumString`
    info	[Changelog] - New enum type `CreatedByType` with values `CreatedByTypeApplication`, `CreatedByTypeKey`, `CreatedByTypeManagedIdentity`, `CreatedByTypeUser`
    info	[Changelog] - New enum type `ManagedServiceIdentityType` with values `ManagedServiceIdentityTypeNone`, `ManagedServiceIdentityTypeSystemAssigned`, `ManagedServiceIdentityTypeSystemAssignedUserAssigned`, `ManagedServiceIdentityTypeUserAssigned`
    info	[Changelog] - New enum type `ProvisioningStateEnum` with values `ProvisioningStateEnumDeleting`, `ProvisioningStateEnumInProgress`, `ProvisioningStateEnumSucceeded`, `ProvisioningStateEnumUpdating`
    info	[Changelog] - New enum type `SourceEnum` with values `SourceEnumCustomer`, `SourceEnumMicrosoft`
    info	[Changelog] - New enum type `TablePlanEnum` with values `TablePlanEnumAnalytics`, `TablePlanEnumBasic`
    info	[Changelog] - New enum type `TableSubTypeEnum` with values `TableSubTypeEnumAny`, `TableSubTypeEnumClassic`, `TableSubTypeEnumDataCollectionRuleBased`
    info	[Changelog] - New enum type `TableTypeEnum` with values `TableTypeEnumCustomLog`, `TableTypeEnumMicrosoft`, `TableTypeEnumRestoredLogs`, `TableTypeEnumSearchResults`
    info	[Changelog] - New function `*ClientFactory.NewQueriesClient() *QueriesClient`
    info	[Changelog] - New function `*ClientFactory.NewQueryPacksClient() *QueryPacksClient`
    info	[Changelog] - New function `NewQueriesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*QueriesClient, error)`
    info	[Changelog] - New function `*QueriesClient.Delete(context.Context, string, string, string, *QueriesClientDeleteOptions) (QueriesClientDeleteResponse, error)`
    info	[Changelog] - New function `*QueriesClient.Get(context.Context, string, string, string, *QueriesClientGetOptions) (QueriesClientGetResponse, error)`
    info	[Changelog] - New function `*QueriesClient.NewListPager(string, string, *QueriesClientListOptions) *runtime.Pager[QueriesClientListResponse]`
    info	[Changelog] - New function `*QueriesClient.Put(context.Context, string, string, string, LogAnalyticsQueryPackQuery, *QueriesClientPutOptions) (QueriesClientPutResponse, error)`
    info	[Changelog] - New function `*QueriesClient.NewSearchPager(string, string, LogAnalyticsQueryPackQuerySearchProperties, *QueriesClientSearchOptions) *runtime.Pager[QueriesClientSearchResponse]`
    info	[Changelog] - New function `*QueriesClient.Update(context.Context, string, string, string, LogAnalyticsQueryPackQuery, *QueriesClientUpdateOptions) (QueriesClientUpdateResponse, error)`
    info	[Changelog] - New function `NewQueryPacksClient(string, azcore.TokenCredential, *arm.ClientOptions) (*QueryPacksClient, error)`
    info	[Changelog] - New function `*QueryPacksClient.CreateOrUpdate(context.Context, string, string, LogAnalyticsQueryPack, *QueryPacksClientCreateOrUpdateOptions) (QueryPacksClientCreateOrUpdateResponse, error)`
    info	[Changelog] - New function `*QueryPacksClient.CreateOrUpdateWithoutName(context.Context, string, LogAnalyticsQueryPack, *QueryPacksClientCreateOrUpdateWithoutNameOptions) (QueryPacksClientCreateOrUpdateWithoutNameResponse, error)`
    info	[Changelog] - New function `*QueryPacksClient.Delete(context.Context, string, string, *QueryPacksClientDeleteOptions) (QueryPacksClientDeleteResponse, error)`
    info	[Changelog] - New function `*QueryPacksClient.Get(context.Context, string, string, *QueryPacksClientGetOptions) (QueryPacksClientGetResponse, error)`
    info	[Changelog] - New function `*QueryPacksClient.NewListByResourceGroupPager(string, *QueryPacksClientListByResourceGroupOptions) *runtime.Pager[QueryPacksClientListByResourceGroupResponse]`
    info	[Changelog] - New function `*QueryPacksClient.NewListPager(*QueryPacksClientListOptions) *runtime.Pager[QueryPacksClientListResponse]`
    info	[Changelog] - New function `*QueryPacksClient.UpdateTags(context.Context, string, string, TagsResource, *QueryPacksClientUpdateTagsOptions) (QueryPacksClientUpdateTagsResponse, error)`
    info	[Changelog] - New function `*TablesClient.CancelSearch(context.Context, string, string, string, *TablesClientCancelSearchOptions) (TablesClientCancelSearchResponse, error)`
    info	[Changelog] - New function `*TablesClient.BeginCreateOrUpdate(context.Context, string, string, string, Table, *TablesClientBeginCreateOrUpdateOptions) (*runtime.Poller[TablesClientCreateOrUpdateResponse], error)`
    info	[Changelog] - New function `*TablesClient.BeginDelete(context.Context, string, string, string, *TablesClientBeginDeleteOptions) (*runtime.Poller[TablesClientDeleteResponse], error)`
    info	[Changelog] - New function `*TablesClient.Migrate(context.Context, string, string, string, *TablesClientMigrateOptions) (TablesClientMigrateResponse, error)`
    info	[Changelog] - New struct `AzureResourceProperties`
    info	[Changelog] - New struct `Column`
    info	[Changelog] - New struct `LogAnalyticsQueryPack`
    info	[Changelog] - New struct `LogAnalyticsQueryPackListResult`
    info	[Changelog] - New struct `LogAnalyticsQueryPackProperties`
    info	[Changelog] - New struct `LogAnalyticsQueryPackQuery`
    info	[Changelog] - New struct `LogAnalyticsQueryPackQueryListResult`
    info	[Changelog] - New struct `LogAnalyticsQueryPackQueryProperties`
    info	[Changelog] - New struct `LogAnalyticsQueryPackQueryPropertiesRelated`
    info	[Changelog] - New struct `LogAnalyticsQueryPackQuerySearchProperties`
    info	[Changelog] - New struct `LogAnalyticsQueryPackQuerySearchPropertiesRelated`
    info	[Changelog] - New struct `ManagedServiceIdentity`
    info	[Changelog] - New struct `QueryPacksResource`
    info	[Changelog] - New struct `RestoredLogs`
    info	[Changelog] - New struct `ResultStatistics`
    info	[Changelog] - New struct `Schema`
    info	[Changelog] - New struct `SearchResults`
    info	[Changelog] - New struct `SystemData`
    info	[Changelog] - New struct `SystemDataAutoGenerated`
    info	[Changelog] - New struct `TagsResource`
    info	[Changelog] - New struct `UserAssignedIdentity`
    info	[Changelog] - New field `SystemData` in struct `Table`
    info	[Changelog] - New field `ArchiveRetentionInDays`, `LastPlanModifiedDate`, `Plan`, `ProvisioningState`, `RestoredLogs`, `ResultStatistics`, `RetentionInDaysAsDefault`, `Schema`, `SearchResults`, `TotalRetentionInDays`, `TotalRetentionInDaysAsDefault` in struct `TableProperties`
    info	[Changelog] - New field `Identity`, `SystemData` in struct `Workspace`
    info	[Changelog] - New field `UnifiedSentinelBillingOnly` in struct `WorkspaceFeatures`
    info	[Changelog] - New field `Identity` in struct `WorkspacePatch`
    info	[Changelog] - New field `DefaultDataCollectionRuleResourceID` in struct `WorkspaceProperties`
    info	[Changelog]
    info	[Changelog] Total 3 breaking change(s), 128 additive change(s).
    Present SDK breaking changes suppressions
    Operation `*TablesClient.Update` has been changed to LRO, use `*TablesClient.BeginUpdate` instead.
    Type of `Cluster.Identity` has been changed from `*Identity` to `*ManagedServiceIdentity`
    Type of `ClusterPatch.Identity` has been changed from `*Identity` to `*ManagedServiceIdentity`
    Please refer to https://aka.ms/azsdk/sdk-suppression for more information.
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from f42052aeedc7c566e794bf4f0f4e8bec688537cf. 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] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    cmderr	[automation_init.sh]
    cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.8.0
    cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.8.0>
    cmderr	[automation_init.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_init.sh] npm notice
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️azure-mgmt-loganalytics [Preview SDK Changes] Breaking Change Detected
    • azure-mgmt-loganalytics-7.0.0b1.zip
    • azure_mgmt_loganalytics-7.0.0b1-py3-none-any.whl
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation TablesOperations.begin_create_or_update
    info	[Changelog]   - Added operation TablesOperations.begin_delete
    info	[Changelog]   - Added operation TablesOperations.cancel_search
    info	[Changelog]   - Added operation TablesOperations.migrate
    info	[Changelog]   - Added operation group QueriesOperations
    info	[Changelog]   - Added operation group QueryPacksOperations
    info	[Changelog]   - Model Table has a new parameter archive_retention_in_days
    info	[Changelog]   - Model Table has a new parameter last_plan_modified_date
    info	[Changelog]   - Model Table has a new parameter plan
    info	[Changelog]   - Model Table has a new parameter provisioning_state
    info	[Changelog]   - Model Table has a new parameter restored_logs
    info	[Changelog]   - Model Table has a new parameter result_statistics
    info	[Changelog]   - Model Table has a new parameter retention_in_days_as_default
    info	[Changelog]   - Model Table has a new parameter schema
    info	[Changelog]   - Model Table has a new parameter search_results
    info	[Changelog]   - Model Table has a new parameter system_data
    info	[Changelog]   - Model Table has a new parameter total_retention_in_days
    info	[Changelog]   - Model Table has a new parameter total_retention_in_days_as_default
    info	[Changelog]   - Model Workspace has a new parameter default_data_collection_rule_resource_id
    info	[Changelog]   - Model Workspace has a new parameter etag
    info	[Changelog]   - Model Workspace has a new parameter identity
    info	[Changelog]   - Model Workspace has a new parameter system_data
    info	[Changelog]   - Model WorkspaceFeatures has a new parameter unified_sentinel_billing_only
    info	[Changelog]   - Model WorkspacePatch has a new parameter default_data_collection_rule_resource_id
    info	[Changelog]   - Model WorkspacePatch has a new parameter identity
    info	[Changelog]
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog]   - Model Table no longer has parameter is_troubleshoot_enabled
    info	[Changelog]   - Model Table no longer has parameter is_troubleshooting_allowed
    info	[Changelog]   - Model Table no longer has parameter last_troubleshoot_date
    info	[Changelog]   - Model Workspace no longer has parameter e_tag
    info	[Changelog]   - Removed operation TablesOperations.create
    info	[Changelog]   - Renamed operation TablesOperations.update to TablesOperations.begin_update
    Present SDK breaking changes suppressions
    Model Table no longer has parameter is_troubleshoot_enabled
    Model Table no longer has parameter is_troubleshooting_allowed
    Model Table no longer has parameter last_troubleshoot_date
    Model Workspace no longer has parameter e_tag
    Removed operation TablesOperations.create
    Renamed operation TablesOperations.update to TablesOperations.begin_update
    Please refer to https://aka.ms/azsdk/sdk-suppression for more information.
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from f42052aeedc7c566e794bf4f0f4e8bec688537cf. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-operationalinsights [Preview SDK Changes] Breaking Change Detected
    • azure-arm-operationalinsights-10.0.0.tgz
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added Interface ManagedServiceIdentity
    info	[Changelog]   - Added Interface UserAssignedIdentity
    info	[Changelog]   - Added Type Alias ManagedServiceIdentityType
    info	[Changelog]   - Interface WorkspaceFeatures has a new optional parameter unifiedSentinelBillingOnly
    info	[Changelog]   - Added Enum KnownManagedServiceIdentityType
    info	[Changelog]   - Enum KnownProvisioningStateEnum has a new value Deleting
    info	[Changelog]
    info	[Changelog] **Breaking Changes**
    info	[Changelog]
    info	[Changelog]   - Type of parameter systemData of interface AzureResourceProperties is changed from SystemData to SystemDataAutoGenerated
    info	[Changelog]   - Type of parameter identity of interface Cluster is changed from Identity to ManagedServiceIdentity
    info	[Changelog]   - Type of parameter identity of interface ClusterPatch is changed from Identity to ManagedServiceIdentity
    info	[Changelog]   - Type of parameter createdByType of interface SystemData is changed from IdentityType to CreatedByType
    info	[Changelog]   - Type of parameter lastModifiedByType of interface SystemData is changed from IdentityType to CreatedByType
    info	[Changelog]   - Type of parameter createdByType of interface SystemDataAutoGenerated is changed from CreatedByType to IdentityType
    info	[Changelog]   - Type of parameter lastModifiedByType of interface SystemDataAutoGenerated is changed from CreatedByType to IdentityType
    info	[Changelog]   - Type of parameter systemData of interface Table is changed from SystemDataAutoGenerated to SystemData
    info	[Changelog]   - Type of parameter systemData of interface Workspace is changed from SystemDataAutoGenerated to SystemData
    Present SDK breaking changes suppressions
    Type of parameter createdByType of interface SystemData is changed from IdentityType to CreatedByType
    Type of parameter createdByType of interface SystemDataAutoGenerated is changed from CreatedByType to IdentityType
    Type of parameter identity of interface Cluster is changed from Identity to ManagedServiceIdentity
    Type of parameter identity of interface ClusterPatch is changed from Identity to ManagedServiceIdentity
    Type of parameter lastModifiedByType of interface SystemData is changed from IdentityType to CreatedByType
    Type of parameter lastModifiedByType of interface SystemDataAutoGenerated is changed from CreatedByType to IdentityType
    Type of parameter systemData of interface AzureResourceProperties is changed from SystemData to SystemDataAutoGenerated
    Type of parameter systemData of interface Table is changed from SystemDataAutoGenerated to SystemData
    Type of parameter systemData of interface Workspace is changed from SystemDataAutoGenerated to SystemData
    Please refer to https://aka.ms/azsdk/sdk-suppression for more information.
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from f42052aeedc7c566e794bf4f0f4e8bec688537cf. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-loganalytics [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-loganalytics-1.1.0-beta.1.jar
    • azure-resourcemanager-loganalytics-1.1.0-beta.1-sources.jar
️❌ azure-resource-manager-schemas failed [Detail]
  • Code Generator Failed in generating from f42052aeedc7c566e794bf4f0f4e8bec688537cf. 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] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az'
    cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'...
    cmderr	[initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types'
    cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'...
    cmderr	[initScript.sh]  notice
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.5.0 -> 10.8.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.8.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[initScript.sh] npm notice
    error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
    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
    cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500
    cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
    cmderr	[generateScript.sh]            ^
    cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
    cmderr	[generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
    cmderr	[generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
    cmderr	[generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig.
    cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500:12)
    cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:504:19)
    cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:739:36)
    cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:955:32)
    cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43)
    cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)
    cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12)
    cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1203:32)
    cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:1019:12)
    cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12)
    error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
    warn	Skip package processing as generation is failed
    error	ERROR: The 'breakingChangesLabel' configuration is missing or incorrect from the 'swagger_to_sdk_config.json file.
️⚠️ azure-powershell warning [Detail]
  • ⚠️Warning in generating from f42052aeedc7c566e794bf4f0f4e8bec688537cf. 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.operationalinsights.DefaultTag [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 2, 2024
@dulikvor dulikvor requested a review from razvanbadea-msft May 22, 2024 17:34
@razvanbadea-msft razvanbadea-msft removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 23, 2024
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 23, 2024
@razvanbadea-msft razvanbadea-msft added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 23, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 23, 2024
@Alancere
Copy link
Contributor

/azp run

Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@raych1
Copy link
Member

raych1 commented May 27, 2024

Approved suppression for Go SDK breaking change since it had been introduced and approved in previous PR.

@kazrael2119
Copy link
Contributor

add @JeffreyRichter as the reviewer because this rp mixed preview and stable versions in the default tag

@dulikvor
Copy link
Contributor Author

add @JeffreyRichter as the reviewer because this rp mixed preview and stable versions in the default tag

Default tag is targeting the latest stable version, not the preview one:
image

@JeffreyRichter
Copy link
Member

Thanks for adding me. Yes, the preview API (Microsoft.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json) cannot be part of a GA package.

@dulikvor
Copy link
Contributor Author

dulikvor commented May 29, 2024

Thanks for adding me. Yes, the preview API (Microsoft.OperationalInsights/preview/2023-01-01-preview/SummaryLogs.json) cannot be part of a GA package.

Hi @JeffreyRichter, thank you for your comment.
Worth to emphasis it's not a stable package but a preview one. the change is only scoped to a single child resource reaching public preview. All other resources depicted in the preview package target the latest stable of each resource. if required we can remove all of them only leaving the single relevant resource in public preview. please confirm this is the correct way of method to move forward.

in general, why we do not introduce a new api version for all existing resources?
We limit our api changes to actual resources who needs to undergo the change.
We have hundreds of resources and child resources, dozens of them depicted through manifest.
Introducing a new api version for all is not feasible effort on the RP side and manifest.

@JeffreyRichter
Copy link
Member

Below is Azure's versioning policy...

By definition, an Azure service is a set of operation endpoints that version uniformly.
The Azure service has a customer-facing name which customers use to find docs, SDKs, etc.
Each version of the service has its own version of the docs, SDKs, etc.

A version is either in preview (api-version=YYYY-MM-DD-preview) or in GA (api-version=YYYY-MM-DD) which means that ALL of the endpoints of that version are either all in preview or all in GA.

Whenever a new preview OR GA version of the service (which includes all operation endpoints) ships, ALL previous preview versions should stop working in 90 days.
If an old preview version has some features that did not make GA and are to remain in preview, then a brand new preview version should ship as a superset of the latest GA and this new preview version will continue to have the features that remain in preview. This way, customers using the latest preview are also using the latest GA plus what remains in preview.
The new preview version must have a later date than the latest GA version so customers know that the new preview is based on the latest GA version.

The above policy ensures that many related processes work correctly such as SDK Packaging, Azure Customer Support, ​breaking changes, PowerShell/CLI, Portal, Azure Stack and Government Clouds, etc. Deviating from the above policy causes many problems for us and for customers.

@dulikvor : Another option is to separate out your endpoints into multiple services (and SDK packages) so that they can version independently and enter in to preview/GA independently.

@kazrael2119 kazrael2119 mentioned this pull request Jun 3, 2024
7 tasks
@dulikvor
Copy link
Contributor Author

dulikvor commented Jun 7, 2024

Below is Azure's versioning policy...

By definition, an Azure service is a set of operation endpoints that version uniformly. The Azure service has a customer-facing name which customers use to find docs, SDKs, etc. Each version of the service has its own version of the docs, SDKs, etc.

A version is either in preview (api-version=YYYY-MM-DD-preview) or in GA (api-version=YYYY-MM-DD) which means that ALL of the endpoints of that version are either all in preview or all in GA.

Whenever a new preview OR GA version of the service (which includes all operation endpoints) ships, ALL previous preview versions should stop working in 90 days. If an old preview version has some features that did not make GA and are to remain in preview, then a brand new preview version should ship as a superset of the latest GA and this new preview version will continue to have the features that remain in preview. This way, customers using the latest preview are also using the latest GA plus what remains in preview. The new preview version must have a later date than the latest GA version so customers know that the new preview is based on the latest GA version.

The above policy ensures that many related processes work correctly such as SDK Packaging, Azure Customer Support, ​breaking changes, PowerShell/CLI, Portal, Azure Stack and Government Clouds, etc. Deviating from the above policy causes many problems for us and for customers.

@dulikvor : Another option is to separate out your endpoints into multiple services (and SDK packages) so that they can version independently and enter in to preview/GA independently.

I would like to extend my gratitude for @JeffreyRichter for investing his time assisting our team with tackling the issue at hand. I will close the PR and will re-open a new one once we are able to meet the requirements listed above.

@dulikvor dulikvor closed this Jun 7, 2024
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.

9 participants