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

Correct the enum value for express route port macsec cipher #12329

Merged
merged 2 commits into from
May 6, 2021

Conversation

magodo
Copy link
Contributor

@magodo magodo commented Jan 8, 2021

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

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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.

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

@openapi-workflow-bot
Copy link

Hi, @magodo 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 8, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.Network/stable/2020-05-01/network.json#L221
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.Network/stable/2020-05-01/network.json#L221
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.Network/stable/2020-05-01/network.json#L221
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.Network/stable/2020-05-01/network.json#L221
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.Network/stable/2020-05-01/network.json#L221
    R3020 - PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces'
    Location: Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json#L37
    R3020 - PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/networkInterfaces'
    Location: Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json#L97
    R3020 - PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}'
    Location: Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json#L150
    R3020 - PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations'
    Location: Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json#L221
    R3020 - PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}'
    Location: Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json#L295
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"network/resource-manager/readme.md",
    "tag":"package-2020-05",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"network/resource-manager/readme.md",
    "tag":"package-2020-05",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-05",
    "details":"Schema 'ResourceNavigationLink' has a property 'id' that is already declared the parent schema 'SubResource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ResourceNavigationLink"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-05",
    "details":"Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration"
    💬 AutorestCore/Exception "readme":"network/resource-manager/readme.md",
    "tag":"package-2020-05",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 8, 2021

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7e3842b. 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
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-05-06 07:04:16 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-network-generated"
      cmderr	[generate.py] 2021-05-06 07:04:16 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-05-06 07:04:16 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.25 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/network/azure-resourcemanager-network-generated --java.namespace=com.azure.resourcemanager.network.generated   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/network/resource-manager/readme.md
      cmderr	[generate.py] 2021-05-06 07:07:42 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-05-06 07:07:42 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-05-06 07:07:42 INFO [POM][Skip] pom already has module azure-resourcemanager-network-generated
      cmderr	[generate.py] 2021-05-06 07:07:42 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-05-06 07:07:42 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-05-06 07:07:42 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-network-generated [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-05-06 07:15:24 DEBUG Got artifact_id: azure-resourcemanager-network-generated
      cmderr	[Inst] 2021-05-06 07:15:24 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-05-06 07:15:24 DEBUG Got artifact: azure-resourcemanager-network-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-05-06 07:15:24 DEBUG Match jar package: azure-resourcemanager-network-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-05-06 07:15:24 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12329/azure-sdk-for-java/azure-resourcemanager-network-generated/azure-resourcemanager-network-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-network-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-network-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-network-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    ️❌ azure-sdk-for-python-track2 failed [Detail]
    • Failed [Logs]Release - Generate from 7e3842b. 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
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ️✔️track2_azure-mgmt-network [View full logsBreaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model VirtualNetworkGateway has a new parameter extended_location
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model VirtualNetworkGateway no longer has parameter virtual_network_extended_location
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		track2_azure-mgmt-network
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7e3842b. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/network/resource-manager/readme.md
    • ️✔️@azure/arm-network [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/networkManagementClient.js → ./dist/arm-network.js...
      cmderr	[npmPack] created ./dist/arm-network.js in 2.4s
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7e3842b. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/network/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.Network [View full logs]  [Release SDK Changes]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7e3842b. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      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	Skip detect changed packages
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @kairu-ms
    Copy link
    Contributor

    @magodo is it a s360 issue?

    @josefree
    Copy link
    Member

    @magodo could you attach the Swagger KPI ADO issue or links to error details, so that PR assignee can know the PR is addressing what issue.

    @magodo
    Copy link
    Contributor Author

    magodo commented Jan 11, 2021

    @josefree No ADO issue for this, how do I create one?

    @openapi-workflow-bot
    Copy link

    Hi @magodo, 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.

    @kairu-ms
    Copy link
    Contributor

    @MikhailTryakhov Please ask service team to confirm and review this change.

    @magodo
    Copy link
    Contributor Author

    magodo commented Jan 12, 2021

    GET https://management.azure.com/subscriptions/x-x-x-x/resourceGroups/mgd-erp/providers/Microsoft.Network/ExpressRoutePorts/magodo-erp?api-version=2020-05-01 HTTP/2.0
    {
        "id": "/subscriptions/x-x-x-x/resourceGroups/mgd-erp/providers/Microsoft.Network/expressRoutePorts/magodo-erp",
        "identity": {
            "type": "userAssigned",
            "userAssignedIdentities": {
                "/subscriptions/x-x-x-x/resourceGroups/mgd-erp/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mgd-identity": {}
            }
        },
        "location": "westus2",
        "name": "magodo-erp",
        "properties": {
            "allocationDate": "Saturday, January 9, 2021",
            "bandwidthInGbps": 10,
            "encapsulation": "Dot1Q",
            "etherType": "0x8100",
            "links": [
                {
                    "id": "/subscriptions/x-x-x-x/resourceGroups/mgd-erp/providers/Microsoft.Network/expressRoutePorts/magodo-erp/links/link1",
                    "name": "link1",
                    "properties": {
                        "adminState": "Disabled",
                        "connectorType": "LC",
                        "interfaceName": "xe-0/1/9:1",
                        "macSecConfig": {
                            "cakSecretIdentifier": "...",
                            "cipher": "GcmAes256",
                            "cknSecretIdentifier": "..."
                        },
                        "patchPanelId": "F1-C2-R13-A - P12",
                        "provisioningState": "Failed",
                        "rackId": "F01C01-AH115",
                        "routerName": "exr01.cbr20"
                    },
                    "type": "Microsoft.Network/expressRoutePorts/links"
                },
                {
                    "id": "/subscriptions/x-x-x-x/resourceGroups/mgd-erp/providers/Microsoft.Network/expressRoutePorts/magodo-erp/links/link2",
                    "name": "link2",
                    "properties": {
                        "adminState": "Disabled",
                        "connectorType": "LC",
                                      "interfaceName": "xe-0/1/9:1",
                        "macSecConfig": {
                            "cipher": "GcmAes128"
                        },
                        "patchPanelId": "F1-C3-R3-A - P12",
                        "provisioningState": "Failed",
                        "rackId": "F01C01-AH116",
                        "routerName": "exr02.cbr20"
                    },
                    "type": "Microsoft.Network/expressRoutePorts/links"
                }
            ],
            "mtu": "1500",
            "peeringLocation": "CDC-Canberra",
            "provisionedBandwidthInGbps": 0.0,
            "provisioningState": "Failed",
            "resourceGuid": "x-x-x-x"
        },
        "tags": {},
        "type": "Microsoft.Network/expressRoutePorts"
    }      
    

    The problematic field is cipher.

    Copy link
    Contributor

    @kairu-ms kairu-ms left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    This enum also exists in other api-versions. We should double check.

    @magodo
    Copy link
    Contributor Author

    magodo commented Jan 12, 2021

    @kairu-ms The newer versions have the correct enum values.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 12, 2021
    @kairu-ms
    Copy link
    Contributor

    @MikhailTryakhov Can you ask service team to verify the response value in different api-versions. Thanks.

    It's already fixed in new api-versions.
    image

    But for previous api-versions the value is still 'gcm-aes-128'
    image

    @kairu-ms
    Copy link
    Contributor

    I fond someone already create a issue for this. Hi @naveenchekuri, can your checkout it?

    This was referenced May 6, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    )
    
    * Correct the enum value for express route port macsec cipher
    
    * format with prettier
    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 CI-BreakingChange-Go CI-BreakingChange-Python DoNotMerge <valid label in PR review process> use to hold merge after approval
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants