Skip to content

Commit 9ee22f5

Browse files
[2108][ContainerRegistry] Make examples return correct json format. (#132)
Make examples return correct json format.
1 parent 39ac2ee commit 9ee22f5

18 files changed

+59
-20
lines changed

src/Azs.ContainerRegistry.Admin/docs/Get-AzsContainerRegistry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Returns a list of container registries present in all tenant location.
2424

2525
### Example 1: Get List Azs Container Registries
2626
```powershell
27-
PS C:\> Get-AzsContainerRegistry
27+
PS C:\> Get-AzsContainerRegistry | ConvertTo-Json
2828
2929
{
3030
"CreationDate": "\/Date(1629160842681)\/",

src/Azs.ContainerRegistry.Admin/docs/Get-AzsContainerRegistryCapacity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Returns container registry capacity property.
3737

3838
### Example 1: Get Azs ContainerRegistry Capacity
3939
```powershell
40-
PS C:\> Get-AzsContainerRegistryCapacity
40+
PS C:\> Get-AzsContainerRegistryCapacity | ConvertTo-Json
4141
4242
{
4343
"AllowPush": true,

src/Azs.ContainerRegistry.Admin/docs/Get-AzsContainerRegistryConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Returns the specified configuration details.
3737

3838
### Example 1: Get AzsContainerRegistry Configuration
3939
```powershell
40-
PS C:\> Get-AzsContainerRegistryConfiguration
40+
PS C:\> Get-AzsContainerRegistryConfiguration | ConvertTo-Json
4141
4242
{{
4343
"Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/configurations/Default",

src/Azs.ContainerRegistry.Admin/docs/Get-AzsContainerRegistryQuota.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Returns the specified container registry quota.
3737

3838
### Example 1: Get List Azs ContainerRegistry Quotas
3939
```powershell
40-
PS C:\> Get-AzsContainerRegistryQuota
40+
PS C:\> Get-AzsContainerRegistryQuota | ConvertTo-Json
4141
4242
[
4343
{
@@ -61,7 +61,7 @@ Returns a list of container registry quotas at the given location.
6161

6262
### Example 2: Get Azs ContainerRegistry Quota by Name
6363
```powershell
64-
PS C:\> Get-AzsContainerRegistryQuota -Name "Default quota"
64+
PS C:\> Get-AzsContainerRegistryQuota -Name "Default quota" | ConvertTo-Json
6565
6666
{
6767
"CapacityPerRegistryInGiB": 20,

src/Azs.ContainerRegistry.Admin/docs/Get-AzsContainerRegistrySetupStatus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Returns the status of the container registry setup.
3131

3232
### Example 1: Get Azs ContainerRegistry Setup Status
3333
```powershell
34-
PS C:\> Get-AzsContainerRegistrySetupStatus
34+
PS C:\> (Get-AzsContainerRegistrySetupStatus).ToJsonString()
3535
3636
{
3737
"id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Setup/locations/redmond/setup/value",

src/Azs.ContainerRegistry.Admin/docs/New-AzsContainerRegistryQuota.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Create or update an existing container registry quota.
3232

3333
### Example 1: New Azs ContainerRegistry Quota
3434
```powershell
35-
PS C:\> New-AzsContainerRegistryQuota -QuotaName testquota -CapacityPerRegistryInGib 20 -NumberOfRegistry 20
35+
PS C:\> New-AzsContainerRegistryQuota -QuotaName testquota -CapacityPerRegistryInGib 20 -NumberOfRegistry 20 | ConvertTo-Json
3636
3737
{
3838
"CapacityPerRegistryInGiB": 20,

src/Azs.ContainerRegistry.Admin/docs/Set-AzsContainerRegistryConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Configure container registry overall configuration properties.
3333

3434
### Example 1: Set Azs ContainerRegistry Configuration
3535
```powershell
36-
PS C:\> Set-AzsContainerRegistryConfiguration -MaximumCapacityInGib 30 -ConfigurationName default
36+
PS C:\> Set-AzsContainerRegistryConfiguration -MaximumCapacityInGib 30 -ConfigurationName default | ConvertTo-Json
3737
3838
{
3939
"Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/configurations/Default",

src/Azs.ContainerRegistry.Admin/docs/Set-AzsContainerRegistryQuota.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Create or update an existing container registry quota.
3232

3333
### Example 1: Set Azs ContainerRegistry Quota
3434
```powershell
35-
PS C:\> Set-AzsContainerRegistryQuota -QuotaName testquota -CapacityPerRegistryInGib 30 -NumberOfRegistry 30
35+
PS C:\> Set-AzsContainerRegistryQuota -QuotaName testquota -CapacityPerRegistryInGib 30 -NumberOfRegistry 30 | ConvertTo-Json
3636
3737
{
3838
"CapacityPerRegistryInGiB": 30,

src/Azs.ContainerRegistry.Admin/docs/Start-AzsContainerRegistrySetup.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,32 @@ Invokes container registry certificate uploading and service deployment.
4444

4545
### Example 1: Start Azs ContainerRegistry Setup
4646
```powershell
47-
PS C:\> Start-AzsContainerRegistrySetup -Password $password -SslCertInputFile $pfx_cert_path
47+
PS C:\> Start-AzsContainerRegistrySetup -Password $password -SslCertInputFile $pfx_cert_path | ConvertTo-Json
4848
49+
{
50+
"Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Setup/locations/redmond/setup/value",
51+
"Name": "redmond/value",
52+
"StatusUri": "https://containerregistrysetup.ascu.azs:4335/providers/Microsoft.ContainerRegistry.Setup/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Setup/locations/redmond/setup?api-version=2019-11-01-preview",
53+
"Type": "Microsoft.ContainerRegistry.Setup/locations/setup"
54+
}
4955
```
5056

5157
Invokes container registry certificate uploading and service deployment.
5258

59+
### Example 2: Start Azs ContainerRegistry Setup when another instance of Setup is already started
60+
```powershell
61+
PS C:\> Start-AzsContainerRegistrySetup -Password $password -SslCertInputFile $pfx_cert_path | ConvertTo-Json
62+
63+
Start-AzsContainerRegistrySetup : Container registry deployment is still running. It is not allowed to repeat deployment at this stage.
64+
At line:1 char:1
65+
+ Start-AzsContainerRegistrySetup -Password $password -SslCertInputFile ...
66+
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
67+
+ CategoryInfo : InvalidOperation: ({ SubscriptionI...SetupProperty }:<>f__AnonymousType7`3) [Start-AzsContai...p_StartExpanded], Exception
68+
+ FullyQualifiedErrorId : AcrDeploymentStillRunning,Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistryAdmin.Cmdlets.StartAzsContainerRegistrySetup_StartExpanded
69+
```
70+
71+
Returns the error if another instance of Setup is already started.
72+
5373
## PARAMETERS
5474

5575
### -DefaultProfile

src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Example 1: Get List Azs Container Registries
22
```powershell
3-
PS C:\> Get-AzsContainerRegistry
3+
PS C:\> Get-AzsContainerRegistry | ConvertTo-Json
44
55
{
66
"CreationDate": "\/Date(1629160842681)\/",

0 commit comments

Comments
 (0)