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 profile level check endpoint name availability API #21646

Merged
merged 2 commits into from
Dec 5, 2022
Merged

Add profile level check endpoint name availability API #21646

merged 2 commits into from
Dec 5, 2022

Conversation

ZianWang02
Copy link
Contributor

@ZianWang02 ZianWang02 commented Nov 24, 2022

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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 24, 2022

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.2)] new version base version
afdx.json 2022-11-01-preview(fe7518e) 2022-11-01-preview(main)
Rule Message
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L85:5
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) new version base version
package-preview-2022-11 package-preview-2022-11(fe7518e) package-preview-2022-11(main)

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

Rule Message Related RPC [For API reviewers]
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: CheckEndpointNameAvailability
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L92


The following errors/warnings exist before current PR submission:

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

Rule Message
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L136
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L185
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L357
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L406
ResourceNameRestriction The resource name parameter 'customDomainName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L406
RepeatedPathInfo The 'profileName' already appears in the path, please don't repeat it in the request body.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L473
CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L521
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L521
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.Cdn/preview/2022-11-01-preview/afdx.json#L614
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L678
ResourceNameRestriction The resource name parameter 'customDomainName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L678
PostOperationAsyncResponseValidation An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L679
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L740
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L789
ResourceNameRestriction The resource name parameter 'endpointName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L789
RepeatedPathInfo The 'profileName' already appears in the path, please don't repeat it in the request body.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L856
CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L899
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.Cdn/preview/2022-11-01-preview/afdx.json#L997
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1061
ResourceNameRestriction The resource name parameter 'endpointName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1061
PostOperationAsyncResponseValidation An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1062
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1132
ResourceNameRestriction The resource name parameter 'endpointName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1132
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1188
ResourceNameRestriction The resource name parameter 'endpointName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1188
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1250
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1299
ResourceNameRestriction The resource name parameter 'originGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1299
RepeatedPathInfo The 'profileName' already appears in the path, please don't repeat it in the request body.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1366
CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
Location: Microsoft.Cdn/preview/2022-11-01-preview/afdx.json#L1409
️️✔️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.

️️✔️~[Staging] SwaggerAPIView 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-workflow-bot
Copy link

Hi, @ZianWang02 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 Nov 24, 2022

    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-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7d4ee6c. 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 major version of npm available! 8.19.2 -> 9.1.3
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.1.3>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.1.3` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-cdn [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation AFDProfilesOperations.begin_upgrade
      info	[Changelog]   - Added operation AFDProfilesOperations.check_endpoint_name_availability
      info	[Changelog]   - Added operation AFDProfilesOperations.validate_secret
      info	[Changelog]   - Added operation ProfilesOperations.begin_migrate
      info	[Changelog]   - Added operation ProfilesOperations.begin_migration_commit
      info	[Changelog]   - Added operation ProfilesOperations.can_migrate
      info	[Changelog]   - Model AFDDomain has a new parameter extended_properties
      info	[Changelog]   - Model AFDDomainProperties has a new parameter extended_properties
      info	[Changelog]   - Model CdnWebApplicationFirewallPolicy has a new parameter extended_properties
      info	[Changelog]   - Model Profile has a new parameter extended_properties
      info	[Changelog]   - Model Profile has a new parameter identity
      info	[Changelog]   - Model ProfileUpdateParameters has a new parameter identity
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Removed operation group ValidateOperations
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7d4ee6c. 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 available: 22.3 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
      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-cdn-generated [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7d4ee6c. 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/cdn/armcdn [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `EndpointProperties.CustomDomains` has been changed from `[]*CustomDomain` to `[]*DeepCreatedCustomDomain`
      info	[Changelog] - Type of `MetricsResponse.Granularity` has been changed from `*MetricsResponseGranularity` to `*MetricsGranularity`
      info	[Changelog] - Type of `MetricsResponseSeriesItem.Unit` has been changed from `*MetricsResponseSeriesItemUnit` to `*MetricsSeriesUnit`
      info	[Changelog] - Type of `WafMetricsResponse.Granularity` has been changed from `*WafMetricsResponseGranularity` to `*WafMetricsGranularity`
      info	[Changelog] - Type of `WafMetricsResponseSeriesItem.Unit` has been changed from `*WafMetricsResponseSeriesItemUnit` to `*WafMetricsSeriesUnit`
      info	[Changelog] - Type alias `MetricsResponseGranularity` has been removed
      info	[Changelog] - Type alias `MetricsResponseSeriesItemUnit` has been removed
      info	[Changelog] - Type alias `WafMetricsResponseGranularity` has been removed
      info	[Changelog] - Type alias `WafMetricsResponseSeriesItemUnit` has been removed
      info	[Changelog] - Function `NewValidateClient` has been removed
      info	[Changelog] - Function `*ValidateClient.Secret` has been removed
      info	[Changelog] - Operation `*CustomDomainsClient.DisableCustomHTTPS` has been changed to LRO, use `*CustomDomainsClient.BeginDisableCustomHTTPS` instead.
      info	[Changelog] - Operation `*CustomDomainsClient.EnableCustomHTTPS` has been changed to LRO, use `*CustomDomainsClient.BeginEnableCustomHTTPS` instead.
      info	[Changelog] - Struct `ValidateClient` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `ProfileResourceStateAbortingMigration`, `ProfileResourceStateCommittingMigration`, `ProfileResourceStateMigrated`, `ProfileResourceStateMigrating`, `ProfileResourceStatePendingMigrationCommit` added to type alias `ProfileResourceState`
      info	[Changelog] - New type alias `CanMigrateDefaultSKU` with values `CanMigrateDefaultSKUPremiumAzureFrontDoor`, `CanMigrateDefaultSKUStandardAzureFrontDoor`
      info	[Changelog] - New type alias `ManagedServiceIdentityType` with values `ManagedServiceIdentityTypeNone`, `ManagedServiceIdentityTypeSystemAssigned`, `ManagedServiceIdentityTypeSystemAssignedUserAssigned`, `ManagedServiceIdentityTypeUserAssigned`
      info	[Changelog] - New type alias `MetricsGranularity` with values `MetricsGranularityP1D`, `MetricsGranularityPT1H`, `MetricsGranularityPT5M`
      info	[Changelog] - New type alias `MetricsSeriesUnit` with values `MetricsSeriesUnitBitsPerSecond`, `MetricsSeriesUnitBytes`, `MetricsSeriesUnitCount`, `MetricsSeriesUnitMilliSeconds`
      info	[Changelog] - New type alias `WafMetricsGranularity` with values `WafMetricsGranularityP1D`, `WafMetricsGranularityPT1H`, `WafMetricsGranularityPT5M`
      info	[Changelog] - New type alias `WafMetricsSeriesUnit` with values `WafMetricsSeriesUnitCount`
      info	[Changelog] - New function `*AFDProfilesClient.CheckEndpointNameAvailability(context.Context, string, string, CheckEndpointNameAvailabilityInput, *AFDProfilesClientCheckEndpointNameAvailabilityOptions) (AFDProfilesClientCheckEndpointNameAvailabilityResponse, error)`
      info	[Changelog] - New function `*AFDProfilesClient.BeginUpgrade(context.Context, string, string, ProfileUpgradeParameters, *AFDProfilesClientBeginUpgradeOptions) (*runtime.Poller[AFDProfilesClientUpgradeResponse], error)`
      info	[Changelog] - New function `*AFDProfilesClient.ValidateSecret(context.Context, string, string, ValidateSecretInput, *AFDProfilesClientValidateSecretOptions) (AFDProfilesClientValidateSecretResponse, error)`
      info	[Changelog] - New function `*ProfilesClient.CanMigrate(context.Context, string, CanMigrateParameters, *ProfilesClientCanMigrateOptions) (ProfilesClientCanMigrateResponse, error)`
      info	[Changelog] - New function `*ProfilesClient.BeginMigrate(context.Context, string, MigrationParameters, *ProfilesClientBeginMigrateOptions) (*runtime.Poller[ProfilesClientMigrateResponse], error)`
      info	[Changelog] - New function `*ProfilesClient.BeginMigrationCommit(context.Context, string, string, *ProfilesClientBeginMigrationCommitOptions) (*runtime.Poller[ProfilesClientMigrationCommitResponse], error)`
      info	[Changelog] - New struct `AFDProfilesClientUpgradeResponse`
      info	[Changelog] - New struct `CanMigrateParameters`
      info	[Changelog] - New struct `CanMigrateResult`
      info	[Changelog] - New struct `DeepCreatedCustomDomain`
      info	[Changelog] - New struct `DeepCreatedCustomDomainProperties`
      info	[Changelog] - New struct `ManagedServiceIdentity`
      info	[Changelog] - New struct `MigrateResult`
      info	[Changelog] - New struct `MigrationErrorType`
      info	[Changelog] - New struct `MigrationParameters`
      info	[Changelog] - New struct `MigrationWebApplicationFirewallMapping`
      info	[Changelog] - New struct `ProfileChangeSKUWafMapping`
      info	[Changelog] - New struct `ProfileUpgradeParameters`
      info	[Changelog] - New struct `ProfilesClientMigrateResponse`
      info	[Changelog] - New struct `ProfilesClientMigrationCommitResponse`
      info	[Changelog] - New struct `UserAssignedIdentity`
      info	[Changelog] - New field `ExtendedProperties` in struct `AFDDomainProperties`
      info	[Changelog] - New field `Identity` in struct `Profile`
      info	[Changelog] - New field `ExtendedProperties` in struct `ProfileProperties`
      info	[Changelog] - New field `Identity` in struct `ProfileUpdateParameters`
      info	[Changelog] - New field `ExtendedProperties` in struct `WebApplicationFirewallPolicyProperties`
      info	[Changelog]
      info	[Changelog] Total 15 breaking change(s), 69 additive change(s).
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from 7d4ee6c. 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] �[91mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:615
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m 615 | �[0m         �[96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m     | �[91m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[91m�[96m     | �[91mFailed to build sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    • Azure.ResourceManager.Cdn [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.Cdn.Models.MetricsResponseGranularity' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/cdn/Azure.ResourceManager.Cdn/src/Azure.ResourceManager.Cdn.csproj],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Nullable<Azure.ResourceManager.Cdn.Models.MetricsResponseSeriesItemUnit> Azure.ResourceManager.Cdn.Models.MetricsResponseSeriesItem.Unit.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/cdn/Azure.ResourceManager.Cdn/src/Azure.ResourceManager.Cdn.csproj],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.Cdn.Models.MetricsResponseSeriesItemUnit' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/cdn/Azure.ResourceManager.Cdn/src/Azure.ResourceManager.Cdn.csproj],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Nullable<Azure.ResourceManager.Cdn.Models.WafMetricsResponseGranularity> Azure.ResourceManager.Cdn.Models.WafMetricsResponse.Granularity.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/cdn/Azure.ResourceManager.Cdn/src/Azure.ResourceManager.Cdn.csproj],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.Cdn.Models.WafMetricsResponseGranularity' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/cdn/Azure.ResourceManager.Cdn/src/Azure.ResourceManager.Cdn.csproj],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Nullable<Azure.ResourceManager.Cdn.Models.WafMetricsResponseSeriesItemUnit> Azure.ResourceManager.Cdn.Models.WafMetricsResponseSeriesItem.Unit.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/cdn/Azure.ResourceManager.Cdn/src/Azure.ResourceManager.Cdn.csproj],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.Cdn.Models.WafMetricsResponseSeriesItemUnit' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/cdn/Azure.ResourceManager.Cdn/src/Azure.ResourceManager.Cdn.csproj],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.Cdn/Debug/netstandard2.0/Azure.ResourceManager.Cdn.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/cdn/Azure.ResourceManager.Cdn/src/Azure.ResourceManager.Cdn.csproj]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7d4ee6c. 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-cdn [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 120 items here, please refer to log for details.
      info	[Changelog]   - Added Interface Endpoint
      info	[Changelog]   - Added Interface EndpointProperties
      info	[Changelog]   - Added Interface EndpointsCreateHeaders
      info	[Changelog]   - Added Interface EndpointsDeleteHeaders
      info	[Changelog]   - Added Interface EndpointsLoadContentHeaders
      info	[Changelog]   - Added Interface EndpointsPurgeContentHeaders
      info	[Changelog]   - Added Interface EndpointsStartHeaders
      info	[Changelog]   - Added Interface EndpointsStopHeaders
      info	[Changelog]   - Added Interface EndpointsUpdateHeaders
      info	[Changelog]   - Added Interface ManagedCertificate
      info	[Changelog]   - Added Interface ManagedCertificateParameters
      info	[Changelog]   - Added Interface ManagedRuleSetDefinition
      info	[Changelog]   - Added Interface ManagedServiceIdentity
      info	[Changelog]   - Added Interface MigrateResult
      info	[Changelog]   - Added Interface MigrationErrorType
      info	[Changelog]   - Added Interface MigrationParameters
      info	[Changelog]   - Added Interface MigrationWebApplicationFirewallMapping
      info	[Changelog]   - Added Interface Origin
      info	[Changelog]   - Added Interface OriginGroup
      info	[Changelog]   - Added Interface OriginGroupOverrideAction
      info	[Changelog]   - Added Interface OriginGroupProperties
      info	[Changelog]   - Added Interface OriginGroupsCreateHeaders
      info	[Changelog]   - Added Interface OriginGroupsDeleteHeaders
      info	[Changelog]   - Added Interface OriginGroupsUpdateHeaders
      info	[Changelog]   - Added Interface OriginProperties
      info	[Changelog]   - Added Interface OriginsCreateHeaders
      info	[Changelog]   - Added Interface OriginsDeleteHeaders
      info	[Changelog]   - Added Interface OriginsUpdateHeaders
      info	[Changelog]   - Added Interface PoliciesCreateOrUpdateHeaders
      info	[Changelog]   - Added Interface PoliciesUpdateHeaders
      info	[Changelog]   - Added Interface Profile
      info	[Changelog]   - Added Interface ProfileChangeSkuWafMapping
      info	[Changelog]   - Added Interface ProfilesCanMigrateOptionalParams
      info	[Changelog]   - Added Interface ProfilesCreateHeaders
      info	[Changelog]   - Added Interface ProfilesDeleteHeaders
      info	[Changelog]   - Added Interface ProfilesMigrateHeaders
      info	[Changelog]   - Added Interface ProfilesMigrateOptionalParams
      info	[Changelog]   - Added Interface ProfilesMigrationCommitHeaders
      info	[Changelog]   - Added Interface ProfilesMigrationCommitOptionalParams
      info	[Changelog]   - Added Interface ProfilesUpdateHeaders
      info	[Changelog]   - Added Interface ProfileUpgradeParameters
      info	[Changelog]   - Added Interface ProxyResource
      info	[Changelog]   - Added Interface RateLimitRule
      info	[Changelog]   - Added Interface Route
      info	[Changelog]   - Added Interface RouteProperties
      info	[Changelog]   - Added Interface RoutesCreateHeaders
      info	[Changelog]   - Added Interface RoutesDeleteHeaders
      info	[Changelog]   - Added Interface RoutesUpdateHeaders
      info	[Changelog]   - Added Interface Rule
      info	[Changelog]   - Added Interface RuleProperties
      info	[Changelog]   - Added Interface RulesCreateHeaders
      info	[Changelog]   - Added Interface RulesDeleteHeaders
      info	[Changelog]   - Added Interface RuleSet
      info	[Changelog]   - Added Interface RuleSetProperties
      info	[Changelog]   - Added Interface RuleSetsDeleteHeaders
      info	[Changelog]   - Added Interface RulesUpdateHeaders
      info	[Changelog]   - Added Interface Secret
      info	[Changelog]   - Added Interface SecretProperties
      info	[Changelog]   - Added Interface SecretsCreateHeaders
      info	[Changelog]   - Added Interface SecretsDeleteHeaders
      info	[Changelog]   - Added Interface SecurityPoliciesCreateHeaders
      info	[Changelog]   - Added Interface SecurityPoliciesDeleteHeaders
      info	[Changelog]   - Added Interface SecurityPoliciesPatchHeaders
      info	[Changelog]   - Added Interface SecurityPolicy
      info	[Changelog]   - Added Interface SecurityPolicyProperties
      info	[Changelog]   - Added Interface SecurityPolicyWebApplicationFirewallParameters
      info	[Changelog]   - Added Interface TrackedResource
      info	[Changelog]   - Added Interface UrlRedirectAction
      info	[Changelog]   - Added Interface UrlRewriteAction
      info	[Changelog]   - Added Interface UrlSigningAction
      info	[Changelog]   - Added Interface UrlSigningKeyParameters
      info	[Changelog]   - Added Interface UserAssignedIdentity
      info	[Changelog]   - Added Interface UserManagedHttpsParameters
      info	[Changelog]   - Added Type Alias AfdProfilesCheckEndpointNameAvailabilityResponse
      info	[Changelog]   - Added Type Alias AfdProfilesUpgradeResponse
      info	[Changelog]   - Added Type Alias AfdProfilesValidateSecretResponse
      info	[Changelog]   - Added Type Alias CanMigrateDefaultSku
      info	[Changelog]   - Added Type Alias EndpointProvisioningState
      info	[Changelog]   - Added Type Alias ManagedServiceIdentityType
      info	[Changelog]   - Added Type Alias MetricsGranularity
      info	[Changelog]   - Added Type Alias MetricsSeriesUnit
      info	[Changelog]   - Added Type Alias OriginGroupProvisioningState
      info	[Changelog]   - Added Type Alias OriginProvisioningState
      info	[Changelog]   - Added Type Alias ProfileProvisioningState
      info	[Changelog]   - Added Type Alias ProfilesCanMigrateResponse
      info	[Changelog]   - Added Type Alias ProfilesMigrateResponse
      info	[Changelog]   - Added Type Alias ResourceUsageUnit
      info	[Changelog]   - Added Type Alias WafMetricsGranularity
      info	[Changelog]   - Added Type Alias WafMetricsSeriesUnit
      info	[Changelog]   - Interface CustomDomainsDisableCustomHttpsOptionalParams has a new optional parameter resumeFrom
      info	[Changelog]   - Interface CustomDomainsDisableCustomHttpsOptionalParams has a new optional parameter updateIntervalInMs
      info	[Changelog]   - Interface CustomDomainsEnableCustomHttpsOptionalParams has a new optional parameter resumeFrom
      info	[Changelog]   - Interface CustomDomainsEnableCustomHttpsOptionalParams has a new optional parameter updateIntervalInMs
      info	[Changelog]   - Interface ProfileUpdateParameters has a new optional parameter identity
      info	[Changelog]   - Added Enum KnownCanMigrateDefaultSku
      info	[Changelog]   - Added Enum KnownEndpointProvisioningState
      info	[Changelog]   - Added Enum KnownManagedServiceIdentityType
      info	[Changelog]   - Added Enum KnownMetricsGranularity
      info	[Changelog]   - Added Enum KnownMetricsSeriesUnit
      info	[Changelog]   - Added Enum KnownOriginGroupProvisioningState
      info	[Changelog]   - Added Enum KnownOriginProvisioningState
      info	[Changelog]   - Added Enum KnownProfileProvisioningState
      info	[Changelog]   - Added Enum KnownResourceUsageUnit
      info	[Changelog]   - Added Enum KnownWafMetricsGranularity
      info	[Changelog]   - Added Enum KnownWafMetricsSeriesUnit
      info	[Changelog]   - Enum KnownProfileResourceState has a new value AbortingMigration
      info	[Changelog]   - Enum KnownProfileResourceState has a new value CommittingMigration
      info	[Changelog]   - Enum KnownProfileResourceState has a new value Migrated
      info	[Changelog]   - Enum KnownProfileResourceState has a new value Migrating
      info	[Changelog]   - Enum KnownProfileResourceState has a new value PendingMigrationCommit
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Removed operation group Validate
      info	[Changelog]   - Removed operation CustomDomains.disableCustomHttps
      info	[Changelog]   - Removed operation CustomDomains.enableCustomHttps
      info	[Changelog]   - Class CdnManagementClient no longer has parameter validate
      info	[Changelog]   - Removed Enum KnownMetricsResponseGranularity
      info	[Changelog]   - Removed Enum KnownMetricsResponseSeriesItemUnit
      info	[Changelog]   - Removed Enum KnownWafMetricsResponseGranularity
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7d4ee6c. 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
    • ️✔️cdn [View full logs
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 7d4ee6c. 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
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 24, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/cdn/armcdn Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Java azure-resourcemanager-cdn-generated Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Python track2_azure-mgmt-cdn Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-cdn Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Nov 24, 2022
    @ghost
    Copy link

    ghost commented Nov 24, 2022

    Thank you for your contribution ZianWang02! We will review the pull request and get back to you soon.

    @ghost ghost added the Network - CDN label Nov 24, 2022
    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 24, 2022
    @openapi-workflow-bot
    Copy link

    Hi, @ZianWang02 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @AzureRestAPISpecReview AzureRestAPISpecReview added NewApiVersionRequired ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager labels Nov 24, 2022
    @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.

    @ZianWang02
    Copy link
    Contributor Author

    @microsoft-github-policy-service agree [company="Microsoft"]

    @ZianWang02
    Copy link
    Contributor Author

    @microsoft-github-policy-service agree company="Microsoft"

    @ZianWang02
    Copy link
    Contributor Author

    ZianWang02 commented Nov 25, 2022

    According to the AddPath Rule, I believe that it can be considered an additive change in new api-version 2022-11-01-preview. Please correct me if I am wrong because it is my first swagger PR. @AzureRestAPISpecReview

    @visingla-ms
    Copy link
    Contributor

    See: http://aka.ms/AzBreakingChangesPolicy/. Adding new path or operation requires a new api version. You can also reach out to Azure Breaking Changes Reviewers azbreakchangereview@microsoft.com for breaking changes information.

    @visingla-ms visingla-ms added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Dec 1, 2022
    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 1, 2022
    @akning-ms
    Copy link
    Contributor

    According to the AddPath Rule, I believe that it can be considered an additive change in new api-version 2022-11-01-preview. Please correct me if I am wrong because it is my first swagger PR. @AzureRestAPISpecReview

    Hi @ZianWang02 , do you know whether there is any SDK already released based on 2022-11-01-preivew, if yes. you may need create new API version to add this new path. if no, consider this version is just merged 23 days ago. we can accept this additive change. normally, adding a new path in existing version is not allown according to breaking change policy

    @ZianWang02
    Copy link
    Contributor Author

    According to the AddPath Rule, I believe that it can be considered an additive change in new api-version 2022-11-01-preview. Please correct me if I am wrong because it is my first swagger PR. @AzureRestAPISpecReview

    Hi @ZianWang02 , do you know whether there is any SDK already released based on 2022-11-01-preivew, if yes. you may need create new API version to add this new path. if no, consider this version is just merged 23 days ago. we can accept this additive change. normally, adding a new path in existing version is not allown according to breaking change policy

    Sure, let me check if there is any SDK released based on 2022-11-01-preview.

    @ZianWang02
    Copy link
    Contributor Author

    ZianWang02 commented Dec 1, 2022

    According to the AddPath Rule, I believe that it can be considered an additive change in new api-version 2022-11-01-preview. Please correct me if I am wrong because it is my first swagger PR. @AzureRestAPISpecReview

    Hi @ZianWang02 , do you know whether there is any SDK already released based on 2022-11-01-preivew, if yes. you may need create new API version to add this new path. if no, consider this version is just merged 23 days ago. we can accept this additive change. normally, adding a new path in existing version is not allown according to breaking change policy

    Sure, let me check if there is any SDK released based on 2022-11-01-preview.

    Hi @akning-ms, I have confirmed with my team that there is no SDK released based on 2022-11-01-preview. Could you please accept this as an additive change?

    @tianxchen-ms tianxchen-ms added Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Dec 1, 2022
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 1, 2022
    @visingla-ms visingla-ms added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Dec 1, 2022
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 1, 2022
    @tianxchen-ms tianxchen-ms merged commit 7d4ee6c into Azure:main Dec 5, 2022
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    * Add profile level check endpoint name availability API
    
    * Update afdx.json
    kayousef-zz pushed a commit to kayousef-zz/azure-rest-api-specs that referenced this pull request Dec 21, 2022
    * Add profile level check endpoint name availability API
    
    * Update afdx.json
    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 ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript customer-reported Issues that are reported by GitHub users external to the Azure organization. Network - CDN NewApiVersionRequired ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants