azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[Hub Generated] Publish private branch 'eventListener'
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [x] new API version
- [ ] update existing version for new feature
- [x] 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.
- 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):
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] 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: :warning:
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:
-
[x] 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.
-
[x] 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.
The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/7806
Hi, @Y-Sindo Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 2 Warnings warning [Detail]
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| webpubsub.json | 2022-08-01-preview(58153c4) | 2021-10-01(main) |
| webpubsub.json | 2022-08-01-preview(58153c4) | 2021-09-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| :warning: 1006 - RemovedDefinition | The new version is missing a definition that was found in the old version. Was 'EventHandlerSettings' removed or renamed? New: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L1780:3 Old: Microsoft.SignalRService/preview/2021-09-01-preview/webpubsub.json#L1072:3 |
| :warning: 1033 - RemovedProperty | The new version is missing a property found in the old version. Was 'eventHandler' renamed or removed? New: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L3170:7 Old: Microsoft.SignalRService/preview/2021-09-01-preview/webpubsub.json#L2125:7 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 8 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-08-01-preview | package-2022-08-01-preview(58153c4) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: R2004 - NonApplicationJsonType | Only 'application/json' content-type is supported by ARM. Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L556 |
|
| :warning: R2004 - NonApplicationJsonType | Only 'application/json' content-type is supported by ARM. Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L773 |
|
| :warning: R4000 - ParameterDescriptionRequired | 'parameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L581 |
|
| :warning: R4000 - ParameterDescriptionRequired | 'parameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L798 |
|
| :warning: R4020 - DescriptiveDescriptionRequired | The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L584 |
|
| :warning: R4020 - DescriptiveDescriptionRequired | The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L801 |
|
| :warning: R4021 - DescriptionAndTitleMissing | 'type' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L2029 |
|
| :warning: R4021 - DescriptionAndTitleMissing | 'type' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L2049 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L3068 |
| :warning: R2029 - PageableOperation | Based on the response model schema, operation 'WebPubSub_ListSkus' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L1735 |
| :warning: R4014 - AllResourcesMustHaveGetOperation | The resource 'PrivateLinkResource' does not have get operation, please add it. Location: Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json#L2465 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 4 Errors, 0 Warnings failed [Detail]
Tag package-2022-08-01-preview; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 34, untested: 0, failed: 4, passed: 30
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
|
"statusCode: 400, errorCode: BadArgument, errorMessage: Referenced custom certificate "myCert" does not exist." |
|
"statusCode: 404, errorCode: NotFound, errorMessage: The resource is not found" |
|
"statusCode: 404, errorCode: NotFound, errorMessage: Private endpoint connection not found" |
|
"statusCode: 404, errorCode: NotFound, errorMessage: Private endpoint connection not found" |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/58153c4cc41140067071e0895c5e4484527f9b20/specification/webpubsub/resource-manager/readme.md#tag-package-2022-08-01-preview">webpubsub/resource-manager/readme.md#package-2022-08-01-preview
| Rule | Message |
|---|---|
| :warning: UnkownSecurityScheme | "readme":"webpubsub/resource-manager/readme.md", "tag":"package-2022-08-01-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️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.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs]Release - Generate from 492cf91751be945ceae53cfdd53b1ff2fb878703. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json warn File azure-sdk-for-net_tmp/initOutput.json not found to read 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:515 cmderr [Invoke-GenerateAndBuildV2.ps1] [96mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [96m 515 | [0m [96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [96m | [91m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [91m[96m | [91mFailed to generate sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m cmderr [Invoke-GenerateAndBuildV2.ps1] [91mGet-ChildItem: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:599 cmderr [Invoke-GenerateAndBuildV2.ps1] [96mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [96m 599 | [0m … rtifacts += [96mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [96m | [91m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [91m[96m | [91mCannot find path cmderr [Invoke-GenerateAndBuildV2.ps1] [96m | [91m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because it does not exist. cmderr [Invoke-GenerateAndBuildV2.ps1] [0m cmderr [Invoke-GenerateAndBuildV2.ps1] [91mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:515 cmderr [Invoke-GenerateAndBuildV2.ps1] [96mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [96m 515 | [0m [96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [96m | [91m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [91m[96m | [91mFailed to generate sdk artifact cmderr [Invoke-GenerateAndBuildV2.ps1] [0m
❌Azure.ResourceManager.WebPubSub [View full logs] [Release SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from 492cf91751be945ceae53cfdd53b1ff2fb878703. SDK Automation 14.0.0command 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.15.0 -> 8.19.2 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-webpubsub [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation group WebPubSubCustomCertificatesOperations info [Changelog] - Added operation group WebPubSubCustomDomainsOperations info [Changelog] - Model WebPubSubHubProperties has a new parameter event_listeners
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 492cf91751be945ceae53cfdd53b1ff2fb878703. SDK Automation 14.0.0command ./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
️✔️azure-resourcemanager-webpubsub [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 492cf91751be945ceae53cfdd53b1ff2fb878703. SDK Automation 14.0.0command 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-webpubsub [View full logs] [Release SDK Changes]info [Changelog] **Features** info [Changelog] info [Changelog] - Added operation group WebPubSubCustomCertificates info [Changelog] - Added operation group WebPubSubCustomDomains info [Changelog] - Added Interface CustomCertificate info [Changelog] - Added Interface CustomCertificateList info [Changelog] - Added Interface CustomDomain info [Changelog] - Added Interface CustomDomainList info [Changelog] - Added Interface EventHubEndpoint info [Changelog] - Added Interface EventListener_2 info [Changelog] - Added Interface EventListenerEndpoint info [Changelog] - Added Interface EventListenerFilter info [Changelog] - Added Interface EventNameFilter info [Changelog] - Added Interface PrivateEndpointACL info [Changelog] - Added Interface PrivateEndpointConnection info [Changelog] - Added Interface PrivateLinkResource info [Changelog] - Added Interface ProxyResource info [Changelog] - Added Interface ResourceReference info [Changelog] - Added Interface SharedPrivateLinkResource info [Changelog] - Added Interface TrackedResource info [Changelog] - Added Interface WebPubSubCustomCertificatesCreateOrUpdateOptionalParams info [Changelog] - Added Interface WebPubSubCustomCertificatesDeleteOptionalParams info [Changelog] - Added Interface WebPubSubCustomCertificatesGetOptionalParams info [Changelog] - Added Interface WebPubSubCustomCertificatesListNextOptionalParams info [Changelog] - Added Interface WebPubSubCustomCertificatesListOptionalParams info [Changelog] - Added Interface WebPubSubCustomDomainsCreateOrUpdateOptionalParams info [Changelog] - Added Interface WebPubSubCustomDomainsDeleteOptionalParams info [Changelog] - Added Interface WebPubSubCustomDomainsGetOptionalParams info [Changelog] - Added Interface WebPubSubCustomDomainsListNextOptionalParams info [Changelog] - Added Interface WebPubSubCustomDomainsListOptionalParams info [Changelog] - Added Interface WebPubSubHub info [Changelog] - Added Interface WebPubSubResource info [Changelog] - Added Type Alias EventListenerEndpointDiscriminator info [Changelog] - Added Type Alias EventListenerEndpointUnion info [Changelog] - Added Type Alias EventListenerFilterDiscriminator info [Changelog] - Added Type Alias EventListenerFilterUnion info [Changelog] - Added Type Alias WebPubSubCustomCertificatesCreateOrUpdateResponse info [Changelog] - Added Type Alias WebPubSubCustomCertificatesGetResponse info [Changelog] - Added Type Alias WebPubSubCustomCertificatesListNextResponse info [Changelog] - Added Type Alias WebPubSubCustomCertificatesListResponse info [Changelog] - Added Type Alias WebPubSubCustomDomainsCreateOrUpdateResponse info [Changelog] - Added Type Alias WebPubSubCustomDomainsGetResponse info [Changelog] - Added Type Alias WebPubSubCustomDomainsListNextResponse info [Changelog] - Added Type Alias WebPubSubCustomDomainsListResponse info [Changelog] - Interface WebPubSubHubProperties has a new optional parameter eventListeners info [Changelog] - Class WebPubSubManagementClient has a new parameter webPubSubCustomCertificates info [Changelog] - Class WebPubSubManagementClient has a new parameter webPubSubCustomDomains info [Changelog] - Added Enum KnownEventListenerEndpointDiscriminator info [Changelog] - Added Enum KnownEventListenerFilterDiscriminator
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 492cf91751be945ceae53cfdd53b1ff2fb878703. SDK Automation 14.0.0command 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/webpubsub/armwebpubsub [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New const `EventListenerFilterDiscriminatorEventName` info [Changelog] - New const `EventListenerEndpointDiscriminatorEventHub` info [Changelog] - New type alias `EventListenerEndpointDiscriminator` info [Changelog] - New type alias `EventListenerFilterDiscriminator` info [Changelog] - New function `*EventNameFilter.GetEventListenerFilter() *EventListenerFilter` info [Changelog] - New function `PossibleEventListenerFilterDiscriminatorValues() []EventListenerFilterDiscriminator` info [Changelog] - New function `PossibleEventListenerEndpointDiscriminatorValues() []EventListenerEndpointDiscriminator` info [Changelog] - New function `*CustomCertificatesClient.BeginCreateOrUpdate(context.Context, string, string, string, CustomCertificate, *CustomCertificatesClientBeginCreateOrUpdateOptions) (*runtime.Poller[CustomCertificatesClientCreateOrUpdateResponse], error)` info [Changelog] - New function `*EventHubEndpoint.GetEventListenerEndpoint() *EventListenerEndpoint` info [Changelog] - New function `NewCustomCertificatesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CustomCertificatesClient, error)` info [Changelog] - New function `*CustomDomainsClient.NewListPager(string, string, *CustomDomainsClientListOptions) *runtime.Pager[CustomDomainsClientListResponse]` info [Changelog] - New function `*CustomCertificatesClient.Delete(context.Context, string, string, string, *CustomCertificatesClientDeleteOptions) (CustomCertificatesClientDeleteResponse, error)` info [Changelog] - New function `NewCustomDomainsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CustomDomainsClient, error)` info [Changelog] - New function `*CustomDomainsClient.BeginDelete(context.Context, string, string, string, *CustomDomainsClientBeginDeleteOptions) (*runtime.Poller[CustomDomainsClientDeleteResponse], error)` info [Changelog] - New function `*EventListenerFilter.GetEventListenerFilter() *EventListenerFilter` info [Changelog] - New function `*CustomDomainsClient.Get(context.Context, string, string, string, *CustomDomainsClientGetOptions) (CustomDomainsClientGetResponse, error)` info [Changelog] - New function `*CustomCertificatesClient.NewListPager(string, string, *CustomCertificatesClientListOptions) *runtime.Pager[CustomCertificatesClientListResponse]` info [Changelog] - New function `*EventListenerEndpoint.GetEventListenerEndpoint() *EventListenerEndpoint` info [Changelog] - New function `*CustomCertificatesClient.Get(context.Context, string, string, string, *CustomCertificatesClientGetOptions) (CustomCertificatesClientGetResponse, error)` info [Changelog] - New function `*CustomDomainsClient.BeginCreateOrUpdate(context.Context, string, string, string, CustomDomain, *CustomDomainsClientBeginCreateOrUpdateOptions) (*runtime.Poller[CustomDomainsClientCreateOrUpdateResponse], error)` info [Changelog] - New struct `CustomCertificate` info [Changelog] - New struct `CustomCertificateList` info [Changelog] - New struct `CustomCertificateProperties` info [Changelog] - New struct `CustomCertificatesClient` info [Changelog] - New struct `CustomCertificatesClientBeginCreateOrUpdateOptions` info [Changelog] - New struct `CustomCertificatesClientCreateOrUpdateResponse` info [Changelog] - New struct `CustomCertificatesClientDeleteOptions` info [Changelog] - New struct `CustomCertificatesClientDeleteResponse` info [Changelog] - New struct `CustomCertificatesClientGetOptions` info [Changelog] - New struct `CustomCertificatesClientGetResponse` info [Changelog] - New struct `CustomCertificatesClientListOptions` info [Changelog] - New struct `CustomCertificatesClientListResponse` info [Changelog] - New struct `CustomDomain` info [Changelog] - New struct `CustomDomainList` info [Changelog] - New struct `CustomDomainProperties` info [Changelog] - New struct `CustomDomainsClient` info [Changelog] - New struct `CustomDomainsClientBeginCreateOrUpdateOptions` info [Changelog] - New struct `CustomDomainsClientBeginDeleteOptions` info [Changelog] - New struct `CustomDomainsClientCreateOrUpdateResponse` info [Changelog] - New struct `CustomDomainsClientDeleteResponse` info [Changelog] - New struct `CustomDomainsClientGetOptions` info [Changelog] - New struct `CustomDomainsClientGetResponse` info [Changelog] - New struct `CustomDomainsClientListOptions` info [Changelog] - New struct `CustomDomainsClientListResponse` info [Changelog] - New struct `EventHubEndpoint` info [Changelog] - New struct `EventListener` info [Changelog] - New struct `EventListenerEndpoint` info [Changelog] - New struct `EventListenerFilter` info [Changelog] - New struct `EventNameFilter` info [Changelog] - New struct `ResourceReference` info [Changelog] - New field `EventListeners` in struct `HubProperties` info [Changelog] info [Changelog] Total 0 breaking change(s), 83 additive change(s).
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from 492cf91751be945ceae53cfdd53b1ff2fb878703. Schema Automation 14.0.0command .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
️✔️webpubsub [View full logs] [Release Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 492cf91751be945ceae53cfdd53b1ff2fb878703. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
️✔️Az.WebPubSub [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/webpubsub/armwebpubsub | https://apiview.dev/Assemblies/Review/326eee18ec5744a6a665fe28675f2e6b |
| Python | track2_azure-mgmt-webpubsub | https://apiview.dev/Assemblies/Review/9f9154e030e0424e8f47bf5910a55eff |
| Java | azure-resourcemanager-webpubsub | https://apiview.dev/Assemblies/Review/6389cceb66da42b9b3bc25b451e5e203 |
| JavaScript | @azure/arm-webpubsub | https://apiview.dev/Assemblies/Review/0f25b4f7c4f44dd6a956c5bd35152f11 |
Hi @Y-Sindo, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
"description": "Success."
No Content
In reply to: 1232053481
In reply to: 1232053481
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:650 in 0baedaf. [](commit_id = 0baedafd0267a25f54a5cee402b6e4a254ee3e3c, deletion_comment = False)
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}": {
suggest updating the variable to be more descriptive i.e
customdomainname vs name
In reply to: 1232056358
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:714 in 0baedaf. [](commit_id = 0baedafd0267a25f54a5cee402b6e4a254ee3e3c, deletion_comment = False)
"201": {
need to include 200 as well here for Re-PUT
In reply to: 1232057607
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:809 in 0baedaf. [](commit_id = 0baedafd0267a25f54a5cee402b6e4a254ee3e3c, deletion_comment = False)
"customCertificate": {
If this is a resource id then rename to end with "Id"
In reply to: 1232059202
In reply to: 1232059202
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:1927 in 0baedaf. [](commit_id = 0baedafd0267a25f54a5cee402b6e4a254ee3e3c, deletion_comment = False)
"customCertificate": {
Looks like the ResourceReference takes care of this. Please ignore the original comment
In reply to: 1232059202
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:1927 in ea39b4a. [](commit_id = ea39b4a1af5580f2dddc1c313d6a4632f0f1760d, deletion_comment = False)
}
How does RBAC work here ? Does the user need to have permissions on the certificate to create the custom domain ?
In reply to: 1232061605
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:1929 in 0baedaf. [](commit_id = 0baedafd0267a25f54a5cee402b6e4a254ee3e3c, deletion_comment = False)
"EventHubEndpoint": {
I dont see this description being used anywhere. Please remove all unused Descriptions from the file.
In reply to: 1232062471
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:1982 in 0baedaf. [](commit_id = 0baedafd0267a25f54a5cee402b6e4a254ee3e3c, deletion_comment = False)
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
"EventHubEndpoint": {I dont see this description being used anywhere. Please remove all unused Descriptions from the file.
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:1982 in 0baedaf. [](commit_id = 0baedaf, deletion_comment = False)
EventHubEndpoint is a derived type of EventListenerEndpoint. And EventNameFilter is a derived type of EventListenerFilter. Polymorphism is used here according to https://github.com/Azure/autorest/blob/main/docs/openapi/howto/polymorphism.md
In reply to: 1232433927
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}": {suggest updating the variable to be more descriptive i.e
customdomainname vs name
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:714 in 0baedaf. [](commit_id = 0baedaf, deletion_comment = False)
Understood. The problem for us is the swagger spec is autogenerated from source code. And the same code is used to generate multiple specs. Renaming the parameter would cause breaking changes to other specs since this name was merged already. Can we keep the current name?
"201": {need to include 200 as well here for Re-PUT
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:809 in 0baedaf. [](commit_id = 0baedaf, deletion_comment = False)
For re-put requests, our RP still needs to handle it asynchorously by design. that means this API will never return 200. Do we still need to add code 200 regardless of the actual behavior?
}How does RBAC work here ? Does the user need to have permissions on the certificate to create the custom domain ?
Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:1929 in 0baedaf. [](commit_id = 0baedaf, deletion_comment = False)
No. There are two different actions: webPubSub/customCertificate/write and webPubSub/customDomain/write which allows customers to define rbac separatedly.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}": {suggest updating the variable to be more descriptive i.e customdomainname vs name Refers to: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2022-08-01-preview/webpubsub.json:714 in 0baedaf. [](commit_id = 0baedaf, deletion_comment = False)
Understood. The problem for us is the swagger spec is autogenerated from source code. And the same code is used to generate multiple specs. Renaming the parameter would cause breaking changes to other specs since this name was merged already. Can we keep the current name?
FYI: Another spec which has the same APIs is in https://github.com/Azure/azure-rest-api-specs/blob/main/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2022-02-01/signalr.json .
In reply to: 1234402627
for puts both 200 and 201 is async : https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#creatingupdating-using-put
Server can indicate it is processing request as a Re-PUT if it returns OK instead of Created
In reply to: 1232786637
No i mean when when you do a customdomain/write you pass in the customcertificate , how do you ensure that the calling used has permissions on the customcertificate ? Are you planning to include linked access checks ? https://armwiki.azurewebsites.net/authorization/RBACLinkedAccessCheck.html?q=linked%20access%20check
In reply to: 1232788275
This is something we discourage since it makes it harder to read the swagger during review.
In reply to: 1234402627
sure, can you make a note for future to keep this format in code ?
In reply to: 1232785540
sure ,will do
for puts both 200 and 201 is async : https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#creatingupdating-using-put
Server can indicate it is processing request as a Re-PUT if it returns OK instead of Created
In reply to: 1232786637
I see. will add 200 to response
No i mean when when you do a customdomain/write you pass in the customcertificate , how do you ensure that the calling used has permissions on the customcertificate ? Are you planning to include linked access checks ? https://armwiki.azurewebsites.net/authorization/RBACLinkedAccessCheck.html?q=linked%20access%20check
In reply to: 1232788275
The person who does customdomain/write does not need a write permission to the customCertificate. Read permission is needed. Do you think we need to enable link access check on customcertificate/read?
No i mean when when you do a customdomain/write you pass in the customcertificate , how do you ensure that the calling used has permissions on the customcertificate ? Are you planning to include linked access checks ? https://armwiki.azurewebsites.net/authorization/RBACLinkedAccessCheck.html?q=linked%20access%20check In reply to: 1232788275
The person who does customdomain/write does not need a write permission to the customCertificate. Read permission is needed. Do you think we need to enable link access check on customcertificate/read?
@juniwang, @raosuhas - Yes, it sounds like you need the linked access read check.
Hi, @Y-Sindo. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}