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

[Az.DeviceRegistry] - Integrate Azure Device Registry APIs into Azure Powershell Commandlets for version 2024-11-01 #26914

Merged
merged 8 commits into from
Dec 30, 2024

Conversation

mryanlo
Copy link

@mryanlo mryanlo commented Dec 21, 2024

Description

This PR integrates the Azure Device Registry APIs into the Azure Powershell Commandlets. I followed the instructions from the autorest autogenerating pwsh guide here. This exposes the GA API version 2024-11-01 of ADRs ARM specs to make them available to call via powershell commandlets.

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • For SDK-based development mode, update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • For autorest-based development mode, include the changelog in the PR description.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

Copy link

azure-client-tools-bot-prd bot commented Dec 21, 2024

️✔️Az.Accounts
️✔️Build
️✔️PowerShell Core - Windows
⚠️Az.DeviceRegistry
️✔️Build
️✔️PowerShell Core - Windows
️✔️Breaking Change Check
️✔️PowerShell Core - Windows
⚠️Signature Check
⚠️PowerShell Core - Windows
Type Cmdlet Description Remediation
⚠️ Get-AzDeviceRegistryAsset Get-AzDeviceRegistryAsset Changes the ConfirmImpact but does not set the SupportsShouldProcess property to true in the cmdlet attribute. Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue
⚠️ Get-AzDeviceRegistryAsset Get-AzDeviceRegistryAsset changes the confirm impact. Please ensure that the change in ConfirmImpact is justified Verify that ConfirmImpact is changed appropriately by the cmdlet. It is very rare for a cmdlet to change the ConfirmImpact.
⚠️ Get-AzDeviceRegistryAssetEndpointProfile Get-AzDeviceRegistryAssetEndpointProfile Changes the ConfirmImpact but does not set the SupportsShouldProcess property to true in the cmdlet attribute. Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue
⚠️ Get-AzDeviceRegistryAssetEndpointProfile Get-AzDeviceRegistryAssetEndpointProfile changes the confirm impact. Please ensure that the change in ConfirmImpact is justified Verify that ConfirmImpact is changed appropriately by the cmdlet. It is very rare for a cmdlet to change the ConfirmImpact.
⚠️ Get-AzDeviceRegistryBillingContainer Get-AzDeviceRegistryBillingContainer Changes the ConfirmImpact but does not set the SupportsShouldProcess property to true in the cmdlet attribute. Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue
⚠️ Get-AzDeviceRegistryBillingContainer Get-AzDeviceRegistryBillingContainer changes the confirm impact. Please ensure that the change in ConfirmImpact is justified Verify that ConfirmImpact is changed appropriately by the cmdlet. It is very rare for a cmdlet to change the ConfirmImpact.
️✔️Help Example Check
️✔️PowerShell Core - Windows
️✔️Help File Existence Check
️✔️PowerShell Core - Windows
⚠️File Change Check
⚠️PowerShell Core - Windows
Type Cmdlet Description Remediation
⚠️ AssemblyInfo.cs will be updated automatically. Please do not update it manually. Revert AssemblyInfo.cs to its last version.
⚠️ It is required to update ChangeLog.md if you want to release a new version for Az.DeviceRegistry. Add a changelog record under Upcoming Release section with past tense.
️✔️UX Metadata Check
️✔️PowerShell Core - Windows
️✔️Test
️✔️PowerShell Core - Linux
️✔️PowerShell Core - MacOS
️✔️PowerShell Core - Windows

## SYNTAX

```
Get-AzDeviceRegistryOperationStatus -Location <String> -OperationId <String> [-SubscriptionId <String[]>]
Copy link
Author

@mryanlo mryanlo Dec 23, 2024

Choose a reason for hiding this comment

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

Do we need to keep OperationStatus at all? Current pwsh commandlets for Create/Update resources automatically wait for async operation status to complete, as well as this pwsh command cannot get the async op uri signing params (see here to successfully run

@mryanlo mryanlo marked this pull request as ready for review December 23, 2024 23:43
@VeryEarly VeryEarly self-assigned this Dec 24, 2024
@VeryEarly
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@VeryEarly
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@VeryEarly
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@VeryEarly VeryEarly merged commit d084096 into Azure:generation Dec 30, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants