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 design review markdown file #1

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Brandon411
Copy link
Owner

PR for reviewing the design review document before submitting it to the PowerShell team.

@Brandon411
Copy link
Owner Author

I see there are some whitespace issues with the parameters in the command syntax, I will fix those


- Sample of end-to-end usage

- Please provide comprehensive examples that don't assume additional setup. It helps the audience understand your feature.

Choose a reason for hiding this comment

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

plz make sure to add example here.

example,
user create partner configuration for specific SubId/RG and add initial publisher to approved/trusted publishers
user authorize or unauthorize specific publisher by immutableid

user create namespace then channel which in return create partner topic
user activate partner topic and create event subscriptioon

Gets a channel or lists all channels under a partner namespace.

PS C:\> Get-AzureEventGridChannel
[-ResourceGroupName] <String>

Choose a reason for hiding this comment

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

ResourceGroupName not optional

Choose a reason for hiding this comment

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

PartnerNamespaceName not optional

Copy link
Owner Author

Choose a reason for hiding this comment

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

I was treating it as a positional variable. The only thing that is optional here is the explicit name of the variable, the value is still required.

[<CommonParameters>]

PS C:\> Get-AzureEventGridChannel
[-ResourceId] <String>

Choose a reason for hiding this comment

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

ResourceId not optional

Copy link
Owner Author

Choose a reason for hiding this comment

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

Is it is a positional variable, the value is still required. Are you saying specifying the parameter should always be required and it shouldn't be a positional variable?


```powershell
NAME
Update-AzEventGridPartnerDestination

Choose a reason for hiding this comment

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

need one for Update-AzEventGridPartnerTopic?

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