Skip to content

Remove stopped search service status#23678

Merged
chunyu3 merged 1 commit intoAzure:mainfrom
enjaimes:enjaimes/remove-stopped
Apr 27, 2023
Merged

Remove stopped search service status#23678
chunyu3 merged 1 commit intoAzure:mainfrom
enjaimes:enjaimes/remove-stopped

Conversation

@enjaimes
Copy link
Contributor

@enjaimes enjaimes commented Apr 21, 2023

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

@enjaimes enjaimes requested a review from tjacobhi as a code owner April 21, 2023 21:41
@openapi-workflow-bot
Copy link

Hi, @enjaimes 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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 21, 2023

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    search.json 2022-09-01(833acbe) 2022-09-01(main)
    Rule Message
    1019 - RemovedEnumValue The new version is removing enum value(s) 'stopped' from the old version.
    New: Microsoft.Search/stable/2022-09-01/search.json#L2023:9
    Old: Microsoft.Search/stable/2022-09-01/search.json#L2023: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 tags (via openapi-validator v2.0.0) new version base version
    package-2022-09 package-2022-09(833acbe) package-2022-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
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Search/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L57
    ResourceNameRestriction The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L73
    PathForResourceAction Path for 'post' method on a resource type MUST follow valid resource naming.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L121
    ResourceNameRestriction The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L121
    PathForResourceAction Path for 'post' method on a resource type MUST follow valid resource naming.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L196
    ResourceNameRestriction The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L196
    ResourceNameRestriction The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L251
    ResourceNameRestriction The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L302
    MissingXmsErrorResponse Response code 404 is defined without a x-ms-error-response.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L348
    ResourceNameRestriction The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L360
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.Search/stable/2022-09-01/search.json#L361
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L488
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L488
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property location.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L488
    MissingXmsErrorResponse Response code 404 is defined without a x-ms-error-response.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L606
    ResourceNameRestriction The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L666
    ResourceNameRestriction The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L717
    ResourceNameRestriction The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L717
    DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.Search/stable/2022-09-01/search.json#L859
    DeleteResponseBodyEmpty The delete response body must be empty.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L862
    MissingXmsErrorResponse Response code 404 is defined without a x-ms-error-response.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L866
    ResourceNameRestriction The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L878
    ResourceNameRestriction The resource name parameter 'searchServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L929
    ResourceNameRestriction The resource name parameter 'sharedPrivateLinkResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L929
    LongRunningResponseStatusCode A 'put' operation 'SharedPrivateLinkResources_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L930
    CreateOperationAsyncResponseValidation An async PUT operation must return 201.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L977
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L984
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L984
    DeleteOperationAsyncResponseValidation An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
    Location: Microsoft.Search/stable/2022-09-01/search.json#L1044
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Search/stable/2022-09-01/search.json#L1083
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView 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.
    ️️✔️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.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 21, 2023

    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-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4d35f0d. 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.Search [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4d35f0d. 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]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.5
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.5>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.5` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-search [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4d35f0d. 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
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-search [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4d35f0d. 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/search/armsearch [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New enum type `AADAuthFailureMode` with values `AADAuthFailureModeHttp401WithBearerChallenge`, `AADAuthFailureModeHttp403`
      info	[Changelog] - New enum type `PrivateLinkServiceConnectionProvisioningState` with values `PrivateLinkServiceConnectionProvisioningStateCanceled`, `PrivateLinkServiceConnectionProvisioningStateDeleting`, `PrivateLinkServiceConnectionProvisioningStateFailed`, `PrivateLinkServiceConnectionProvisioningStateIncomplete`, `PrivateLinkServiceConnectionProvisioningStateSucceeded`, `PrivateLinkServiceConnectionProvisioningStateUpdating`
      info	[Changelog] - New enum type `SearchEncryptionComplianceStatus` with values `SearchEncryptionComplianceStatusCompliant`, `SearchEncryptionComplianceStatusNonCompliant`
      info	[Changelog] - New enum type `SearchEncryptionWithCmk` with values `SearchEncryptionWithCmkDisabled`, `SearchEncryptionWithCmkEnabled`, `SearchEncryptionWithCmkUnspecified`
      info	[Changelog] - New struct `DataPlaneAADOrAPIKeyAuthOption`
      info	[Changelog] - New struct `DataPlaneAuthOptions`
      info	[Changelog] - New struct `EncryptionWithCmk`
      info	[Changelog] - New field `GroupID`, `ProvisioningState` in struct `PrivateEndpointConnectionProperties`
      info	[Changelog] - New field `AuthOptions`, `DisableLocalAuth`, `EncryptionWithCmk` in struct `ServiceProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 25 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4d35f0d. 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-search [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface DataPlaneAadOrApiKeyAuthOption
      info	[Changelog]   - Added Interface DataPlaneAuthOptions
      info	[Changelog]   - Added Interface EncryptionWithCmk
      info	[Changelog]   - Added Type Alias AadAuthFailureMode
      info	[Changelog]   - Added Type Alias PrivateLinkServiceConnectionProvisioningState
      info	[Changelog]   - Added Type Alias SearchEncryptionComplianceStatus
      info	[Changelog]   - Added Type Alias SearchEncryptionWithCmk
      info	[Changelog]   - Interface PrivateEndpointConnectionProperties has a new optional parameter groupId
      info	[Changelog]   - Interface PrivateEndpointConnectionProperties has a new optional parameter provisioningState
      info	[Changelog]   - Interface SearchService has a new optional parameter authOptions
      info	[Changelog]   - Interface SearchService has a new optional parameter disableLocalAuth
      info	[Changelog]   - Interface SearchService has a new optional parameter encryptionWithCmk
      info	[Changelog]   - Interface SearchServiceUpdate has a new optional parameter authOptions
      info	[Changelog]   - Interface SearchServiceUpdate has a new optional parameter disableLocalAuth
      info	[Changelog]   - Interface SearchServiceUpdate has a new optional parameter encryptionWithCmk
      info	[Changelog]   - Added Enum KnownPrivateLinkServiceConnectionProvisioningState
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4d35f0d. 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]  WARN 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
    • ️✔️search [View full logs
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 4d35f0d. 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
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ️✔️Az.search.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.search.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 21, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/search/armsearch https://apiview.dev/Assemblies/Review/88512ec5c12d42309d8e27fa240a6755
    .Net Azure.ResourceManager.Search There is no API change compared with the previous version
    JavaScript @azure/arm-search https://apiview.dev/Assemblies/Review/ea1020a705bf471f88a2397c9f0cd1c5

    @openapi-workflow-bot
    Copy link

    Hi @enjaimes, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @kazrael2119
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Apr 26, 2023
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager Search

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    5 participants

    Comments