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

Add subnet reference to SessionPool #32791

Open
wants to merge 15 commits into
base: release-app-Microsoft.App-preview/2025-02-02-Preview
Choose a base branch
from

Conversation

ebencarek
Copy link
Contributor

@ebencarek ebencarek commented Feb 24, 2025

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.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • 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.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • 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.

Copy link

openapi-pipeline-app bot commented Feb 24, 2025

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented Feb 24, 2025

@github-actions github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Feb 24, 2025
@razvanbadea-msft
Copy link
Contributor

fix the Swagger LintDiffFailing and Swagger PrettierCheck checks

@razvanbadea-msft razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Feb 25, 2025
@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 Feb 25, 2025
@ebencarek
Copy link
Contributor Author

@razvanbadea-msft can you provide some guidance on how we can fix this error:

image

We don't have any required properties in our object model SessionPoolUpdatableProperties, however we do want to allow patching managed identity properties, and so we reference common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity, which does have a required type field, which I believe the linter is catching, but this is a common type so we can't change it.

We have this same model in our previous API versions, and also this has nothing to do with the change I'm making. How can we proceed?

@ebencarek
Copy link
Contributor Author

Found issue: https://github.com/Azure/typespec-azure/issues/383 - will try to implement the workaround

@ebencarek
Copy link
Contributor Author

/azp run

Copy link

Commenter does not have sufficient privileges for PR 32791 in repo Azure/azure-rest-api-specs

@ebencarek
Copy link
Contributor Author

/azp run

Copy link

Commenter does not have sufficient privileges for PR 32791 in repo Azure/azure-rest-api-specs

@ebencarek
Copy link
Contributor Author

LintDiff still reporting as failed but it's not showing any warnings or errors:

image

image

@ebencarek ebencarek removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Feb 26, 2025
@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 Feb 26, 2025
@jianingwang123
Copy link

Hi @ebencarek,
According to https://github.com/Azure/azure-rest-api-specs/actions/runs/13532571432/job/37817890205?pr=32791#step:4:86, your tspconfig.yaml is incorrectly configured. Kindly update your tspconfig.yaml as per the details provided below.
Please let us know if you need any further assistance.

  - The value of options.@azure-tools/typespec-java.package-dir "microsoft-app-dynamicsessions" does not match "/^azure(-\w+)+$/". Please update the value of "options.@azure-tools/typespec-java.package-dir" to match "/^azure(-\w+)+$/".
  - The value of options.@azure-tools/typespec-csharp.package-dir "Microsoft.App.DynamicSessions" does not match "/^Azure\./". Please update the value of "options.@azure-tools/typespec-csharp.package-dir" to match "/^Azure\./".

@razvanbadea-msft
Copy link
Contributor

/azp run

Copy link

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

@razvanbadea-msft
Copy link
Contributor

LintDiff still reporting as failed but it's not showing any warnings or errors:

image

image

i think the reason for this it is because tof the tag changes in readme file

{
"type": "AutoRest exception",
"message": "[Exception] No input files provided.Use --help to get help information or see https://aka.ms/autorest/cli for additional documentation",
"readmeUrl": "https://github.com/Azure/azure-rest-api-specs/blob/release-app-Microsoft.App-preview/2025-02-02-Preview/specification/app/resource-manager/readme.md",
"tag": "default",
"context": "before"
},
{
"type": "AutoRest exception",
"message": "!Error: [Exception] No input files provided.Use --help to get help information or see https://aka.ms/autorest/cli for additional documentation",
"readmeUrl": "https://github.com/Azure/azure-rest-api-specs/blob/release-app-Microsoft.App-preview/2025-02-02-Preview/specification/app/resource-manager/readme.md",
"tag": "default",
"context": "before"
},
{
"type": "AutoRest exception",
"message": "stack: Error: [Exception] No input files provided.Use --help to get help information or see https://aka.ms/autorest/cli for additional documentation at processInternal (/home/cloudtest/.autorest/@[email protected]/node_modules/@autorest/core/dist/src_lib_autorest-core_ts.js:123:32) at processTicksAndRejections (node:internal/process/task_queues:95:5) at currentMain (/home/cloudtest/.autorest/@[email protected]/node_modules/@autorest/core/dist/app.js:142:24) at main (/home/cloudtest/.autorest/@[email protected]/node_modules/@autorest/core/dist/app.js:289:16)",
"readmeUrl": "https://github.com/Azure/azure-rest-api-specs/blob/release-app-Microsoft.App-preview/2025-02-02-Preview/specification/app/resource-manager/readme.md",
"tag": "default",
"context": "before"
},
{
"type": "AutoRest exception",
"message": "Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.",
"readmeUrl": "https://github.com/Azure/azure-rest-api-specs/blob/release-app-Microsoft.App-preview/2025-02-02-Preview/specification/app/resource-manager/readme.md",
"tag": "default",
"context": "before"
}

@razvanbadea-msft razvanbadea-msft added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Feb 26, 2025
@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 Feb 26, 2025
@ebencarek
Copy link
Contributor Author

ebencarek commented Feb 26, 2025

Hi @ebencarek, According to https://github.com/Azure/azure-rest-api-specs/actions/runs/13532571432/job/37817890205?pr=32791#step:4:86, your tspconfig.yaml is incorrectly configured. Kindly update your tspconfig.yaml as per the details provided below. Please let us know if you need any further assistance.

  - The value of options.@azure-tools/typespec-java.package-dir "microsoft-app-dynamicsessions" does not match "/^azure(-\w+)+$/". Please update the value of "options.@azure-tools/typespec-java.package-dir" to match "/^azure(-\w+)+$/".
  - The value of options.@azure-tools/typespec-csharp.package-dir "Microsoft.App.DynamicSessions" does not match "/^Azure\./". Please update the value of "options.@azure-tools/typespec-csharp.package-dir" to match "/^Azure\./".

@jianingwang123 these are for data plane APIs which I am not trying to modify, they are already checked into the main branch. I'm just trying to add a new property in a control plane API preview version.

@ebencarek
Copy link
Contributor Author

i think the reason for this it is because tof the tag changes in readme file

@razvanbadea-msft - I changed the package tag in the readme because there was a mismatch causing a different error:

image

I don't have any idea how to go about fixing that issue

@ebencarek
Copy link
Contributor Author

/azp run

Copy link

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants