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.

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

Jump to bottom

Change default deployment for MS team channel to CommercialDeployment #28985

Closed
wants to merge 1 commit into from
Closed

Change default deployment for MS team channel to CommercialDeployment #28985

wants to merge 1 commit into from

Conversation

kmodi98
Copy link

@kmodi98 kmodi98 commented May 6, 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.

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 6, 2024 •
edited
Loading

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR is not ready for ARM review (label: NotReadyForARMReview). This PR will not be reviewed by ARM until relevant problems are fixed. Consult the rest of this Next Steps to Merge comment for details.
    Once the blocking problems are addressed, add to the PR a comment with contents /azp run. Automation will re-evaluate this PR and if everything looks good, it will add WaitForARMFeedback label which will put this PR on the ARM review queue.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ This PR is NotReadyForARMReview because it has the BreakingChangeReviewRequired label.
  • ❌ This PR has at least one breaking change (label: BreakingChangeReviewRequired).
    To unblock this PR, follow the process at aka.ms/brch.
  • ❌ The required check named Swagger SpellCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 6, 2024 •
edited
Loading

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
Compared specs (v0.10.8) new version base version
botservice.json 2023-09-15-preview(bc849be) 2023-09-15-preview(main)
Rule Message
❌ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2412:9
Old: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2412:9
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-preview-2023-09 package-preview-2023-09(bc849be) package-preview-2023-09(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
❌ PutRequestResponseSchemeArm A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Bots_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema'
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L31
❌ PatchResponseCodes Synchronous PATCH operations must have responses with 200 and default return codes. They also must not have other response codes.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L86
❌ UnSupportedPatchProperties Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L104
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L109
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:displayName.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L109
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:endpoint.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L109
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:msaAppId.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L109
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:publicNetworkAccess.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L109
❌ ResourceNameRestriction The resource name parameter 'channelName' should be defined with a 'pattern' restriction.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L304
❌ RepeatedPathInfo The 'channelName' already appears in the path, please don't repeat it in the request body.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L335
❌ PatchResponseCodes Synchronous PATCH operations must have responses with 200 and default return codes. They also must not have other response codes.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L375
❌ UnSupportedPatchProperties Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L405
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L410
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:channelName.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L410
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:location.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L410
❌ ResourceNameRestriction The resource name parameter 'channelName' should be defined with a 'pattern' restriction.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L556
❌ ResourceNameRestriction The resource name parameter 'channelName' should be defined with a 'pattern' restriction.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L646
❌ OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.BotService/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L807
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L808
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L937
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L991
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L997
❌ PatchResponseCodes Synchronous PATCH operations must have responses with 200 and default return codes. They also must not have other response codes.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1009
❌ UnSupportedPatchProperties Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1030
❌ UnSupportedPatchProperties Mark the property 'properties.provisioningState', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1030
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1034
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1049
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1055
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1098
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1200
️️✔️Avocado succeeded [Detail] [Expand] 
Validation passes for Avocado.
️️✔️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: 4 Errors, 0 Warnings failed [Detail]
Rule Message
❌ HowToFix Unknown word (networksecurityperimeter), please fix the error. See https://aka.ms/ci-fix#spell-check
path: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1534:24
❌ HowToFix Unknown word (networksecurityperimeter), please fix the error. See https://aka.ms/ci-fix#spell-check
path: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1544:26
❌ HowToFix Unknown word (networksecurityperimeter), please fix the error. See https://aka.ms/ci-fix#spell-check
path: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1590:26
❌ HowToFix Unknown word (networksecurityperimeter), please fix the error. See https://aka.ms/ci-fix#spell-check
path: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1626:24
️️✔️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?

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 6, 2024 •
edited
Loading

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand] 
 Please click here to preview with your @microsoft account.
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 240350840bd5b2fc2bd45df7960b33ed83d3634a. 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.BotService [Preview SDK Changes]
    • Azure.ResourceManager.BotService.1.2.0-alpha.20240506.1.nupkg
    info	[Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from 240350840bd5b2fc2bd45df7960b33ed83d3634a. 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.
cmderr	[automation_init.sh]
cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.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-botservice [Preview SDK Changes]
    • azure-mgmt-botservice-0.2.0.zip
    • azure_mgmt_botservice-0.2.0-py3-none-any.whl
    info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation group NetworkSecurityPerimeterConfigurationsOperations
info	[Changelog]   - Model BotProperties has a new parameter network_security_perimeter_configurations
info	[Changelog]   - Model ConnectionSettingProperties has a new parameter id
info	[Changelog]   - Model ConnectionSettingProperties has a new parameter name
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 240350840bd5b2fc2bd45df7960b33ed83d3634a. 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/botservice/armbotservice [Preview SDK Changes]
️❌ azure-resource-manager-schemas failed [Detail]
  • ❌Failed in generating from 240350840bd5b2fc2bd45df7960b33ed83d3634a. 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] npm notice
cmderr	[initScript.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[initScript.sh] npm notice
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
  • ❌botservice/resource-manager [Preview Schema Changes]
️🔄 azure-sdk-for-js inProgress [Detail]
️❌ azure-powershell failed [Detail]
  • ❌Code Generator Failed in generating from 240350840bd5b2fc2bd45df7960b33ed83d3634a. SDK Automation 14.0.0 
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
error	Script return with result [failed] code [2] signal [null] cwd [azure-powershell]: sh ./tools/SwaggerCI/init.sh
warn	File azure-powershell_tmp/initOutput.json not found to read
error	Fatal error: ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json'
ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json'
error	Fatal error: Error: ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json'    at Object.openSync (node:fs:596:3)    at Object.writeFileSync (node:fs:2322:35)    at writeTmpJsonFile (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/utils/fsUtils.js:125:18)    at workflowCallGenerateScript (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:582:36)    at workflowHandleReadmeMdOrTypeSpecProject (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:235:46)    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)    at async workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:107:9)    at async sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:215:13)    at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
error	ERROR: The 'breakingChangesLabel' configuration is missing or incorrect from the 'swagger_to_sdk_config.json file.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 6, 2024 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/botservice/armbotservice https://apiview.dev/Assemblies/Review/27fe64b3ab374f879e7b1cd4ca87b939?revisionId=e6fded2b6e98434ab7d5de1108b6deef
.Net Azure.ResourceManager.BotService https://apiview.dev/Assemblies/Review/3e2ec949028441d1a66e99380432407f?revisionId=3d3a6a0642994175bd0ddb3852efd3bd
Swagger Microsoft.BotService https://apiview.dev/Assemblies/Review/b1b623986e7b4599ab6ffd63d35dee9d?revisionId=217b117a4d934b22b0a5090586f641a5

This was referenced May 6, 2024
Draft
Closed
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager labels May 6, 2024
This was referenced May 6, 2024
Closed
Closed
Closed
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels May 27, 2024
@kmodi98 kmodi98 closed this Jun 6, 2024
@kmodi98 kmodi98 deleted the user/kartikmodi/BUG-28636 branch June 6, 2024 04:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kmodi98 @AzureRestAPISpecReview