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 DNS API's to AVS 2020-07-17-preview #11876

Merged
merged 1 commit into from
Dec 8, 2020
Merged

Conversation

ctaggart
Copy link
Contributor

@ctaggart ctaggart commented Dec 1, 2020

This adds DNS APIs to a preview version. It was developed and reviewed privately at https://github.com/Azure/azure-rest-api-specs-pr/pull/2408 before this. We are not building SDKs for this preview version. This preview API is only in Azure public cloud.


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-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 1, 2020

Swagger Validation Report

️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]

Rule Message
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L2662:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L2707:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L2914:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L2959:5
️⚠️LintDiff: 8 Warnings warning [Detail]

Rule Message
⚠️ R4009 - RequiredSystemDataInNewApiVersions The response of operation:'WorkloadNetworks_ListDnsServices' is defined without 'systemData'. Consider adding the systemData to the response.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L2663
⚠️ R4009 - RequiredSystemDataInNewApiVersions The response of operation:'WorkloadNetworks_GetDnsService' is defined without 'systemData'. Consider adding the systemData to the response.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L2708
⚠️ R4009 - RequiredSystemDataInNewApiVersions The response of operation:'WorkloadNetworks_CreateDnsService' is defined without 'systemData'. Consider adding the systemData to the response.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L2751
⚠️ R4009 - RequiredSystemDataInNewApiVersions The response of operation:'WorkloadNetworks_UpdateDnsService' is defined without 'systemData'. Consider adding the systemData to the response.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L2810
⚠️ R4009 - RequiredSystemDataInNewApiVersions The response of operation:'WorkloadNetworks_ListDnsZones' is defined without 'systemData'. Consider adding the systemData to the response.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L2915
⚠️ R4009 - RequiredSystemDataInNewApiVersions The response of operation:'WorkloadNetworks_GetDnsZone' is defined without 'systemData'. Consider adding the systemData to the response.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L2960
⚠️ R4009 - RequiredSystemDataInNewApiVersions The response of operation:'WorkloadNetworks_CreateDnsZone' is defined without 'systemData'. Consider adding the systemData to the response.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L3003
⚠️ R4009 - RequiredSystemDataInNewApiVersions The response of operation:'WorkloadNetworks_UpdateDnsZone' is defined without 'systemData'. Consider adding the systemData to the response.
New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L3062
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 1, 2020

Swagger Generation Artifacts

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from a985437. 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/vmware/resource-manager/readme.md
  • ️✔️@azure/arm-avs [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/avsClient.js → ./dist/arm-avs.js...
    cmderr	[npmPack] created ./dist/arm-avs.js in 509ms
️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from a985437. SDK Automation 14.0.0
    warn	Skip initScript due to not configured
    command	npx n 12
    command	python3 -m venv venv
    command	pip install --upgrade setuptools wheel pip
    command	pip install pathlib jinja2 msrestazure
    command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/vmware/resource-manager/readme.md
  • ️✔️azure-mgmt-avs [View full logs]  [Release SDK Changes] Breaking Change Detected
    cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-avs
    cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
    cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
    cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-avs
    cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
    cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
    cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
    cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
    cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
    cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.avs
    cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.avs
    cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.avs
    cmderr	[changelogReport] INFO:__main__:Report written to sdk/compute/azure-mgmt-avs/code_reports/latest/report.json
    cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-avs on PyPI
    cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '1.0.0rc1', '1.0.0']
    cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
    cmderr	[changelogReportLatest] INFO:__main__:Installing version 1.0.0 of azure-mgmt-avs in a venv
    cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
    cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.avs
    cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.avs
    cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.avs
    cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/compute/azure-mgmt-avs/code_reports/1.0.0/report.json
    cmdout	[Changelog] Size of delta 59.840% size of original (original: 52731 chars, delta: 31554 chars)
    cmdout	[Changelog] **Features**
    cmdout	[Changelog]   - Model PrivateCloudUpdate has a new parameter nsxt_password
    cmdout	[Changelog]   - Model PrivateCloudUpdate has a new parameter vcenter_password
    cmdout	[Changelog]   - Added operation group WorkloadNetworksOperations
    cmdout	[Changelog]   - Added operation group GlobalReachConnectionsOperations
    cmdout	[Changelog] **Breaking changes**
    cmdout	[Changelog]   - Operation ClustersOperations.create_or_update has a new signature
    cmdout	[Changelog]   - Operation ClustersOperations.create_or_update has a new signature
    cmdout	[Changelog]   - Operation HcxEnterpriseSitesOperations.create_or_update has a new signature
    cmdout	[Changelog]   - Operation AuthorizationsOperations.create_or_update has a new signature
    warn	Breaking change found in changelog
️⚠️ azure-sdk-for-net warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from a985437. 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/vmware/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.Avs [View full logs]  [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from a985437. SDK Automation 14.0.0
    command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️preview/avs/mgmt/2020-07-17-preview/avs [View full logs]  [Release SDK Changes]
    Only show 40 items here, please refer to log for details.
    info	[Changelog] 1. WorkloadNetworksClient.ListDNSServices(context.Context, string, string) (WorkloadNetworkDNSServicesListPage, error)
    info	[Changelog] 1. WorkloadNetworksClient.ListDNSServicesComplete(context.Context, string, string) (WorkloadNetworkDNSServicesListIterator, error)
    info	[Changelog] 1. WorkloadNetworksClient.ListDNSServicesPreparer(context.Context, string, string) (*http.Request, error)
    info	[Changelog] 1. WorkloadNetworksClient.ListDNSServicesResponder(*http.Response) (WorkloadNetworkDNSServicesList, error)
    info	[Changelog] 1. WorkloadNetworksClient.ListDNSServicesSender(*http.Request) (*http.Response, error)
    info	[Changelog] 1. WorkloadNetworksClient.ListDNSZones(context.Context, string, string) (WorkloadNetworkDNSZonesListPage, error)
    info	[Changelog] 1. WorkloadNetworksClient.ListDNSZonesComplete(context.Context, string, string) (WorkloadNetworkDNSZonesListIterator, error)
    info	[Changelog] 1. WorkloadNetworksClient.ListDNSZonesPreparer(context.Context, string, string) (*http.Request, error)
    info	[Changelog] 1. WorkloadNetworksClient.ListDNSZonesResponder(*http.Response) (WorkloadNetworkDNSZonesList, error)
    info	[Changelog] 1. WorkloadNetworksClient.ListDNSZonesSender(*http.Request) (*http.Response, error)
    info	[Changelog] 1. WorkloadNetworksClient.UpdateDNSService(context.Context, string, string, string, WorkloadNetworkDNSService) (WorkloadNetworksUpdateDNSServiceFuture, error)
    info	[Changelog] 1. WorkloadNetworksClient.UpdateDNSServicePreparer(context.Context, string, string, string, WorkloadNetworkDNSService) (*http.Request, error)
    info	[Changelog] 1. WorkloadNetworksClient.UpdateDNSServiceResponder(*http.Response) (WorkloadNetworkDNSService, error)
    info	[Changelog] 1. WorkloadNetworksClient.UpdateDNSServiceSender(*http.Request) (WorkloadNetworksUpdateDNSServiceFuture, error)
    info	[Changelog] 1. WorkloadNetworksClient.UpdateDNSZone(context.Context, string, string, string, WorkloadNetworkDNSZone) (WorkloadNetworksUpdateDNSZoneFuture, error)
    info	[Changelog] 1. WorkloadNetworksClient.UpdateDNSZonePreparer(context.Context, string, string, string, WorkloadNetworkDNSZone) (*http.Request, error)
    info	[Changelog] 1. WorkloadNetworksClient.UpdateDNSZoneResponder(*http.Response) (WorkloadNetworkDNSZone, error)
    info	[Changelog] 1. WorkloadNetworksClient.UpdateDNSZoneSender(*http.Request) (WorkloadNetworksUpdateDNSZoneFuture, error)
    info	[Changelog]
    info	[Changelog] ## Struct Changes
    info	[Changelog]
    info	[Changelog] ### New Structs
    info	[Changelog]
    info	[Changelog] 1. WorkloadNetworkDNSService
    info	[Changelog] 1. WorkloadNetworkDNSServiceProperties
    info	[Changelog] 1. WorkloadNetworkDNSServicesList
    info	[Changelog] 1. WorkloadNetworkDNSServicesListIterator
    info	[Changelog] 1. WorkloadNetworkDNSServicesListPage
    info	[Changelog] 1. WorkloadNetworkDNSZone
    info	[Changelog] 1. WorkloadNetworkDNSZoneProperties
    info	[Changelog] 1. WorkloadNetworkDNSZonesList
    info	[Changelog] 1. WorkloadNetworkDNSZonesListIterator
    info	[Changelog] 1. WorkloadNetworkDNSZonesListPage
    info	[Changelog] 1. WorkloadNetworksCreateDNSServiceFuture
    info	[Changelog] 1. WorkloadNetworksCreateDNSZoneFuture
    info	[Changelog] 1. WorkloadNetworksDeleteDNSServiceFuture
    info	[Changelog] 1. WorkloadNetworksDeleteDNSZoneFuture
    info	[Changelog] 1. WorkloadNetworksUpdateDNSServiceFuture
    info	[Changelog] 1. WorkloadNetworksUpdateDNSZoneFuture
    info	[Changelog]
  • ️✔️avs/mgmt/2020-03-20/avs [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️preview/avs/mgmt/2019-08-09-preview/avs [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from a985437. Schema Automation 14.0.0
    warn	Skip initScript due to not configured
    command	npx n 12
    command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6320 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/vmware/resource-manager/readme.md
  • ️✔️vmware [View full logs]  [Release Schema Changes]
    cmderr	[resource-manager] node-pre-gyp
    cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
    cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 No repository field.
    cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.2 (node_modules/fsevents):
    cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.2: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
️❌ azure-sdk-for-java failed [Detail]
  • Failed [Logs]Release - Generate from a985437. 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] 2020-12-08 12:29:24 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-avs"
    cmderr	[generate.py] 2020-12-08 12:29:24 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
    cmderr	[generate.py] 2020-12-08 12:29:24 INFO autorest --version=3.0.6327 --use=@autorest/java@4.0.5 --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/avs/azure-resourcemanager-avs --java.namespace=com.azure.resourcemanager.avs  --package-version=1.0.0-beta.1 --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --pipeline.modelerfour.flatten-payloads=false --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/vmware/resource-manager/readme.md
    cmderr	[generate.py] ERROR (PreCheck/PropertyRedeclaration): Schema 'PrivateCloudProperties' has a property 'vcenterPassword' that is conflicting with a property in the parent schema 'PrivateCloudUpdateProperties' differs more than just description : [enum => '<removed>',x-ms-enum => '<removed>',x-ms-secret => 'true']
    cmderr	[generate.py] ERROR (PreCheck/PropertyRedeclaration): Schema 'PrivateCloudProperties' has a property 'nsxtPassword' that is conflicting with a property in the parent schema 'PrivateCloudUpdateProperties' differs more than just description : [enum => '<removed>',x-ms-enum => '<removed>',x-ms-secret => 'true']
    cmderr	[generate.py] FATAL: Error: 2 errors occured -- cannot continue.
    cmderr	[generate.py]   Error: Plugin prechecker reported failure.
    cmderr	[generate.py] 2020-12-08 12:30:02 ERROR [GENERATE] Autorest fail
    ENOENT: no such file or directory, stat 'azure-sdk-for-java/sdk/avs/azure-resourcemanager-avs/pom.xml'
    Error: ENOENT: no such file or directory, stat 'azure-sdk-for-java/sdk/avs/azure-resourcemanager-avs/pom.xml'
  • ️✔️azure-resourcemanager-avs [View full logs
    error	Fatal error: ENOENT: no such file or directory, stat 'azure-sdk-for-java/sdk/avs/azure-resourcemanager-avs/pom.xml'
    error	The following packages are still pending:
    error		azure-resourcemanager-avs
️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
Posted by Swagger Pipeline | How to fix these errors?

@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.

@ctaggart
Copy link
Contributor Author

ctaggart commented Dec 1, 2020

A new API version is not required because this is only for Azure public cloud and there are no client libraries for it. For the same reasons, it is also not a breaking change. I will be reviewing this with the breaking change board review on Monday, December 7th with work item https://msazure.visualstudio.com/One/_workitems/edit/8893405.

@JeffreyRichter JeffreyRichter self-assigned this Dec 7, 2020
@JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Dec 7, 2020
@ctaggart
Copy link
Contributor Author

ctaggart commented Dec 7, 2020

Hi @leni-msft, please merge. The breaking change has been approved.

@leni-msft
Copy link
Contributor

@ArcturusZhang Pls help check the go sdk error

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-Python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants