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

Update New-AzContainerGroup Example6 #17515

Merged
merged 3 commits into from
Mar 23, 2022

Conversation

CaptainFanZzz
Copy link
Contributor

@CaptainFanZzz CaptainFanZzz commented Mar 17, 2022

Description

Update New-AzContainerGroup Example6
Generation branch #17552
Fix for #17123

Checklist

  • I have read the Submitting Changes section of CONTRIBUTING.md
  • The title of the PR is clear and informative
  • The appropriate ChangeLog.md file(s) has been updated:
    • For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
    • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header -- no new version header should be added
  • The PR does not introduce breaking changes
  • If applicable, the changes made in the PR have proper test coverage
  • For public API changes to cmdlets:
    • a cmdlet design review was approved for the changes in this repository (Microsoft internal only)
      • {Please put the link here}
    • the markdown help files have been regenerated using the commands listed here

@@ -122,7 +123,7 @@ Location Name Zone ResourceGroupName
eastus test-cg test-rg
```

This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry.
This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry. For the volume property, AzureFile and GitRepo are recommanded. The EmptyDir property isn't supported.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry. For the volume property, AzureFile and GitRepo are recommanded. The EmptyDir property isn't supported.
This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry.

recommanded -> recommended

We support mounting Azure File share as a volume or specifying git repository as volume directory. The empty directory volume and secret volume are not supported yet.

Please add this statement in the docs of New-AzContainerGroupVolumeObject

@@ -20,7 +20,7 @@ New-AzContainerGroupVolumeObject -Name <String> [-AzureFileReadOnly] [-AzureFile
```

## DESCRIPTION
Create a in-memory object for Volume
Create a in-memory object for Volume. Currently, we support mounting Azure File share as a volume or specifying git repository as volume directory. The empty directory volume and secret volume are not supported yet.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm hesitating to do this job. The description is auto-generated, I'm afraid that this change will be overridden in next change. Is there any way to customize description of cmdlets? @dolauli

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

How about New-AzContainerGroup? It's a customized cmdlet after generated . Can we use the same way?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks @dolauli .

@BethanyZhou
Copy link
Contributor

As @jaltin mentioned, could you create a separate PR for this issue? @CaptainFanZzz

@CaptainFanZzz
Copy link
Contributor Author

As @jaltin mentioned, could you create a separate PR for this issue? @CaptainFanZzz

Okay

@@ -122,7 +123,7 @@ Location Name Zone ResourceGroupName
eastus test-cg test-rg
```

This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry.
This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry. For the volume property, AzureFile and GitRepo are recommended. The EmptyDir property isn't supported.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry. For the volume property, AzureFile and GitRepo are recommended. The EmptyDir property isn't supported.
This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry.

Remove unrelated description for this example.

Copy link
Contributor

@BethanyZhou BethanyZhou left a comment

Choose a reason for hiding this comment

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

lgtm

@BethanyZhou BethanyZhou merged commit fe4ea79 into Azure:main Mar 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants