Update readme.python.md #17482

msyyc · 2022-01-25T02:53:38Z

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

Changelog

Add a changelog entry for this PR by answering the following questions:

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
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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 · 2022-01-25T02:53:40Z

Hi, @msyyc 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 · 2022-01-25T02:53:41Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

️️✔️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).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2022-01-25T02:53:41Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2022-01-25T02:53:42Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

️⌛SDK Breaking Change Tracking pending [Detail]

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from ae88d63. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.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/applicationinsights/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.ApplicationInsights [View full logs] [Release SDK Changes]

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from ae88d63. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.1.2 -> 8.3.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.3.2>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.3.2` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-applicationinsights [View full logs] [Release SDK Changes]
- azure-mgmt-applicationinsights-2.0.0.zip
- azure_mgmt_applicationinsights-2.0.0-py3-none-any.whl
```
info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model OperationLive has a new parameter is_data_action
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from ae88d63. 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] 2022-01-25 09:44:59 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-applicationinsights;1.0.0-beta.2;1.0.0-beta.3"
cmderr	[generate.py] 2022-01-25 09:44:59 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.3"
cmderr	[generate.py] 2022-01-25 09:44:59 INFO autorest --version=3.6.6 --use=@autorest/java@4.0.47 --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/applicationinsights/azure-resourcemanager-applicationinsights --java.namespace=com.azure.resourcemanager.applicationinsights   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --generate-samples --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/applicationinsights/resource-manager/readme.md
cmderr	[generate.py] 2022-01-25 09:45:37 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-applicationinsights
cmderr	[generate.py] 2022-01-25 09:45:37 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2022-01-25 09:45:37 INFO [POM][Skip] pom already has module azure-resourcemanager-applicationinsights
cmderr	[generate.py] 2022-01-25 09:45:37 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2022-01-25 09:45:37 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2022-01-25 09:45:37 INFO [POM][Skip] pom already has module sdk/applicationinsights
cmderr	[generate.py] 2022-01-25 09:45:37 INFO [POM][Success] Write to root pom

️✔️azure-resourcemanager-applicationinsights [View full logs] [Release SDK Changes]

cmderr	[Inst] 2022-01-25 09:47:39 DEBUG Got artifact_id: azure-resourcemanager-applicationinsights
cmderr	[Inst] 2022-01-25 09:47:39 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2022-01-25 09:47:39 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.3.jar
cmderr	[Inst] 2022-01-25 09:47:39 DEBUG Match jar package: azure-resourcemanager-applicationinsights-1.0.0-beta.3.jar
cmderr	[Inst] 2022-01-25 09:47:39 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/17482/azure-sdk-for-java/azure-resourcemanager-applicationinsights/azure-resourcemanager-applicationinsights-1.0.0-beta.3.jar\" -o azure-resourcemanager-applicationinsights-1.0.0-beta.3.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-applicationinsights -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-applicationinsights-1.0.0-beta.3.jar -Dpackaging=jar -DgeneratePom=true
```"}

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from ae88d63. SDK Automation 14.0.0

command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️appinsights/mgmt/2020-02-02/insights [View full logs] [Release SDK Changes]

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Const `ItemTypeFolder` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `ItemTypeNone`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 1 additive change(s).

️✔️appinsights/mgmt/2015-05-01/insights [View full logs]

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Const `Folder` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `None`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 1 additive change(s).

️✔️preview/appinsights/mgmt/2021-11-01-preview/insights [View full logs]

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Const `ItemTypeFolder` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `ItemTypeNone`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 1 additive change(s).

️✔️preview/appinsights/mgmt/2020-02-02-preview/insights [View full logs]
```
info	[Changelog] This package was removed
info	[Changelog]
```

️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from ae88d63. 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

️✔️armapplicationinsights [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `WorkbookTemplateLocalizedGallery.TemplateData` has been changed from `map[string]interface{}` to `interface{}`
info	[Changelog] - Type of `WorkbookTemplateProperties.TemplateData` has been changed from `map[string]interface{}` to `interface{}`
info	[Changelog] - Function `OperationListResult.MarshalJSON` has been removed
info	[Changelog] - Function `InnerError.MarshalJSON` has been removed
info	[Changelog] - Function `*OperationsClientListPager.PageResponse` has been removed
info	[Changelog] - Function `*InnerError.UnmarshalJSON` has been removed
info	[Changelog] - Function `*OperationsClientListPager.Err` has been removed
info	[Changelog] - Function `WorkbookTemplateErrorBody.MarshalJSON` has been removed
info	[Changelog] - Function `InnerErrorTrace.MarshalJSON` has been removed
info	[Changelog] - Function `WorkbookInnerErrorTrace.MarshalJSON` has been removed
info	[Changelog] - Function `*OperationsClient.List` has been removed
info	[Changelog] - Function `*OperationsClientListPager.NextPage` has been removed
info	[Changelog] - Function `OperationsListResult.MarshalJSON` has been removed
info	[Changelog] - Function `NewOperationsClient` has been removed
info	[Changelog] - Struct `AnnotationError` has been removed
info	[Changelog] - Struct `ErrorDefinition` has been removed
info	[Changelog] - Struct `ErrorResponse` has been removed
info	[Changelog] - Struct `ErrorResponseLinkedStorage` has been removed
info	[Changelog] - Struct `ErrorResponseLinkedStorageError` has been removed
info	[Changelog] - Struct `InnerError` has been removed
info	[Changelog] - Struct `InnerErrorTrace` has been removed
info	[Changelog] - Struct `MyWorkbookError` has been removed
info	[Changelog] - Struct `Operation` has been removed
info	[Changelog] - Struct `OperationDisplay` has been removed
info	[Changelog] - Struct `OperationInfo` has been removed
info	[Changelog] - Struct `OperationListResult` has been removed
info	[Changelog] - Struct `OperationLive` has been removed
info	[Changelog] - Struct `OperationsClient` has been removed
info	[Changelog] - Struct `OperationsClientListOptions` has been removed
info	[Changelog] - Struct `OperationsClientListPager` has been removed
info	[Changelog] - Struct `OperationsClientListResponse` has been removed
info	[Changelog] - Struct `OperationsClientListResult` has been removed
info	[Changelog] - Struct `OperationsListResult` has been removed
info	[Changelog] - Struct `WorkItemConfigurationError` has been removed
info	[Changelog] - Struct `WorkbookError` has been removed
info	[Changelog] - Struct `WorkbookErrorDefinition` has been removed
info	[Changelog] - Struct `WorkbookInnerErrorTrace` has been removed
info	[Changelog] - Struct `WorkbookTemplateError` has been removed
info	[Changelog] - Struct `WorkbookTemplateErrorBody` has been removed
info	[Changelog] - Struct `WorkbookTemplateErrorFieldContract` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `Name` in struct `ComponentProperties`
info	[Changelog] - New field `ForceCustomerStorageForProfiler` in struct `ComponentProperties`
info	[Changelog] - New field `DisableLocalAuth` in struct `ComponentProperties`
info	[Changelog] - New field `WorkspaceResourceID` in struct `ComponentProperties`
info	[Changelog] - New field `LaMigrationDate` in struct `ComponentProperties`
info	[Changelog] - New field `Etag` in struct `Component`
info	[Changelog]
info	[Changelog] Total 66 breaking change(s), 2 additive change(s).

️⚠️ azure-sdk-for-js warning [Detail]

⚠️Warning [Logs]Release - Generate from ae88d63. 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
cmderr	[automation_init.sh] WARN deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh]  deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
cmderr	[automation_init.sh]  @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
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

️✔️track2_@azure/arm-appinsights [View full logs] [Release SDK Changes]
- azure-arm-appinsights-5.0.0-beta.2.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from ae88d63. 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

️✔️applicationinsights [View full logs]

_{Posted by Swagger Pipeline | How to fix these errors?}

msyyc · 2022-01-25T02:54:34Z

https://github.com/Azure/sdk-release-request/issues/2402

msyyc · 2022-01-25T09:16:17Z

/azp run

Update readme.python.md

bfcbe36

msyyc requested a review from BigCat20196 as a code owner January 25, 2022 02:53

msyyc self-assigned this Jan 25, 2022

openapi-pipeline-app bot added the CI-BreakingChange-Go-V2 label Jan 25, 2022

BigCat20196 approved these changes Jan 25, 2022

View reviewed changes

msyyc merged commit ae88d63 into main Jan 25, 2022

msyyc deleted the applicationingishts-python-config branch January 25, 2022 03:14

mstrisoline pushed a commit to mstrisoline/azure-rest-api-specs that referenced this pull request Feb 1, 2022

Update readme.python.md (Azure#17482)

3c162d5

LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022

Update readme.python.md (Azure#17482)

f00e6db

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update readme.python.md #17482

Update readme.python.md #17482

msyyc commented Jan 25, 2022

openapi-workflow-bot bot commented Jan 25, 2022

openapi-pipeline-app bot commented Jan 25, 2022 •

edited

Loading

openapi-workflow-bot bot commented Jan 25, 2022

openapi-pipeline-app bot commented Jan 25, 2022 •

edited

Loading

msyyc commented Jan 25, 2022

msyyc commented Jan 25, 2022

Update readme.python.md #17482

Update readme.python.md #17482

Conversation

msyyc commented Jan 25, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jan 25, 2022

openapi-pipeline-app bot commented Jan 25, 2022 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Jan 25, 2022

openapi-pipeline-app bot commented Jan 25, 2022 • edited Loading

Swagger Generation Artifacts

msyyc commented Jan 25, 2022

msyyc commented Jan 25, 2022

openapi-pipeline-app bot commented Jan 25, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jan 25, 2022 •

edited

Loading