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

[Hub Generated] Publish private branch 'datafactory/liudan7/AddGen2SasAuthSwagger' #22565

Conversation

Jingshu923
Copy link
Contributor

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

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.

@Jingshu923
Copy link
Contributor Author

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/10528

@openapi-workflow-bot
Copy link

Hi, @Jingshu923 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 Feb 13, 2023

    Swagger Validation Report

    ️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    LinkedService.json 2018-06-01(2c15ed7) 2018-06-01(main)
    Rule Message
    1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
    New: stable/2018-06-01/entityTypes/LinkedService.json#L2580:7
    Old: stable/2018-06-01/entityTypes/LinkedService.json#L2580:7
    1045 - AddedOptionalProperty The new version has a new optional property 'sasUri' that was not found in the old version.
    New: stable/2018-06-01/entityTypes/LinkedService.json#L2580:7
    Old: stable/2018-06-01/entityTypes/LinkedService.json#L2580:7
    1045 - AddedOptionalProperty The new version has a new optional property 'sasToken' that was not found in the old version.
    New: stable/2018-06-01/entityTypes/LinkedService.json#L2580:7
    Old: stable/2018-06-01/entityTypes/LinkedService.json#L2580:7
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2018-06 package-2018-06(2c15ed7) package-2018-06(main)
    ️️✔️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]
    ️️✔️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.
    ️️✔️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 Feb 13, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking


    azure-sdk-for-python-track2 - track2_azure-mgmt-datafactory - 2.10.0
    +	Parameter export_settings of model SnowflakeSource is now required
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from 631094a. 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
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:760
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 760 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    • Azure.ResourceManager.DataFactory [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 631094a. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.5.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.5.0` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-datafactory [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group CredentialOperationsOperations
      info	[Changelog]   - Model AzureBlobFSLinkedService has a new parameter sas_token
      info	[Changelog]   - Model AzureBlobFSLinkedService has a new parameter sas_uri
      info	[Changelog]   - Model AzureBlobStorageLinkedService has a new parameter authentication_type
      info	[Changelog]   - Model AzureBlobStorageLinkedService has a new parameter container_uri
      info	[Changelog]   - Model IntegrationRuntimeComputeProperties has a new parameter copy_compute_scale_properties
      info	[Changelog]   - Model IntegrationRuntimeComputeProperties has a new parameter pipeline_external_compute_scale_properties
      info	[Changelog]   - Model SynapseSparkJobDefinitionActivity has a new parameter configuration_type
      info	[Changelog]   - Model SynapseSparkJobDefinitionActivity has a new parameter scan_folder
      info	[Changelog]   - Model SynapseSparkJobDefinitionActivity has a new parameter spark_config
      info	[Changelog]   - Model SynapseSparkJobDefinitionActivity has a new parameter target_spark_configuration
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Parameter export_settings of model SnowflakeSource is now required
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 631094a. 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/datafactory/armdatafactory [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - Type of `SynapseSparkJobActivityTypeProperties.NumExecutors` has been changed from `*int32` to `any`
      info	[Changelog] - New type alias `AzureStorageAuthenticationType` with values `AzureStorageAuthenticationTypeAccountKey`, `AzureStorageAuthenticationTypeAnonymous`, `AzureStorageAuthenticationTypeMsi`, `AzureStorageAuthenticationTypeSasURI`, `AzureStorageAuthenticationTypeServicePrincipal`
      info	[Changelog] - New type alias `ConfigurationType` with values `ConfigurationTypeArtifact`, `ConfigurationTypeCustomized`, `ConfigurationTypeDefault`
      info	[Changelog] - New type alias `SparkConfigurationReferenceType` with values `SparkConfigurationReferenceTypeSparkConfigurationReference`
      info	[Changelog] - New function `*Credential.GetCredential() *Credential`
      info	[Changelog] - New function `NewCredentialOperationsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CredentialOperationsClient, error)`
      info	[Changelog] - New function `*CredentialOperationsClient.CreateOrUpdate(context.Context, string, string, string, ManagedIdentityCredentialResource, *CredentialOperationsClientCreateOrUpdateOptions) (CredentialOperationsClientCreateOrUpdateResponse, error)`
      info	[Changelog] - New function `*CredentialOperationsClient.Delete(context.Context, string, string, string, *CredentialOperationsClientDeleteOptions) (CredentialOperationsClientDeleteResponse, error)`
      info	[Changelog] - New function `*CredentialOperationsClient.Get(context.Context, string, string, string, *CredentialOperationsClientGetOptions) (CredentialOperationsClientGetResponse, error)`
      info	[Changelog] - New function `*CredentialOperationsClient.NewListByFactoryPager(string, string, *CredentialOperationsClientListByFactoryOptions) *runtime.Pager[CredentialOperationsClientListByFactoryResponse]`
      info	[Changelog] - New function `*ManagedIdentityCredential.GetCredential() *Credential`
      info	[Changelog] - New function `*ServicePrincipalCredential.GetCredential() *Credential`
      info	[Changelog] - New struct `CopyComputeScaleProperties`
      info	[Changelog] - New struct `CredentialListResponse`
      info	[Changelog] - New struct `CredentialOperationsClient`
      info	[Changelog] - New struct `ManagedIdentityCredential`
      info	[Changelog] - New struct `ManagedIdentityCredentialResource`
      info	[Changelog] - New struct `ManagedIdentityTypeProperties`
      info	[Changelog] - New struct `PipelineExternalComputeScaleProperties`
      info	[Changelog] - New struct `ServicePrincipalCredential`
      info	[Changelog] - New struct `ServicePrincipalCredentialTypeProperties`
      info	[Changelog] - New struct `SparkConfigurationParametrizationReference`
      info	[Changelog] - New field `SasToken` in struct `AzureBlobFSLinkedServiceTypeProperties`
      info	[Changelog] - New field `SasURI` in struct `AzureBlobFSLinkedServiceTypeProperties`
      info	[Changelog] - New field `AuthenticationType` in struct `AzureBlobStorageLinkedServiceTypeProperties`
      info	[Changelog] - New field `ContainerURI` in struct `AzureBlobStorageLinkedServiceTypeProperties`
      info	[Changelog] - New field `CopyComputeScaleProperties` in struct `IntegrationRuntimeComputeProperties`
      info	[Changelog] - New field `PipelineExternalComputeScaleProperties` in struct `IntegrationRuntimeComputeProperties`
      info	[Changelog] - New field `ConfigurationType` in struct `SynapseSparkJobActivityTypeProperties`
      info	[Changelog] - New field `ScanFolder` in struct `SynapseSparkJobActivityTypeProperties`
      info	[Changelog] - New field `SparkConfig` in struct `SynapseSparkJobActivityTypeProperties`
      info	[Changelog] - New field `TargetSparkConfiguration` in struct `SynapseSparkJobActivityTypeProperties`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 45 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 631094a. 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-datafactory [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Interface AzureBlobFSLinkedService has a new optional parameter sasToken
      info	[Changelog]   - Interface AzureBlobFSLinkedService has a new optional parameter sasUri
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 631094a. 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
    • ️✔️datafactory [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 631094a. 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.datafactory [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the Data Factory label Feb 13, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 13, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/datafactory/armdatafactory https://apiview.dev/Assemblies/Review/05129a1d110b49d8a62049c1e06bdccf
    Java azure-resourcemanager-datafactory https://apiview.dev/Assemblies/Review/4aca976ef9a9442caf9cf2a3096f2cb0
    JavaScript @azure/arm-datafactory https://apiview.dev/Assemblies/Review/5663149edec44fe999fa6635bac22482

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @leni-msft leni-msft added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 20, 2023
    @leni-msft
    Copy link
    Contributor

    @tadelesh @qiaozha @msyyc please review SDK breaking changes

    @tadelesh
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @leni-msft
    Copy link
    Contributor

    The remaining python sdk breaking change "Parameter export_settings of model SnowflakeSource is now required" is not related with PR. So I'll ignore the check. cc. @msyyc

    @leni-msft leni-msft merged commit 631094a into main Feb 21, 2023
    @leni-msft leni-msft deleted the published/Azure/azure-rest-api-specs-pr/datafactory/liudan7/AddGen2SasAuthSwagger branch February 21, 2023 02:14
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    …sAuthSwagger' (Azure#22565)
    
    * [AutoSync] 565f69b429 Added Gen2 Sas auth swagger
    
    * [AutoSync] 431ef878dc Fixed reference to secret
    
    ---------
    
    Co-authored-by: swagger-automation <swagger@microsoft.com>
    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 CI-BreakingChange-Go CI-BreakingChange-JavaScript Data Factory NewApiVersionRequired resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants