Skip to content

Commit c5e5d38

Browse files
bganaparjainilarisaborodina
authored
ACR Admin module Initial version (#130)
* Initial code changes * ACR auto-generating cmdlets. * ACR auto-generating cmdlets. - #2 * Add pester tests for all the cmdlets. * Add examples for all the cmdlets. * Increase vertion to 0.2.0 to avoid clashing with manually released 0.1.3 version. * Replace Read-AzsContainerRegistry to Get-AzsContainerRegistry. * Add missed Get-AzsContainerRegistry.Recording.json * Add docs for all cmdlets * Initial code changes * ACR auto-generating cmdlets. * ACR auto-generating cmdlets. - #2 * Add pester tests for all the cmdlets. * Add examples for all the cmdlets. * Increase vertion to 0.2.0 to avoid clashing with manually released 0.1.3 version. * Replace Read-AzsContainerRegistry to Get-AzsContainerRegistry. * Add missed Get-AzsContainerRegistry.Recording.json * Add docs for all cmdlets Co-authored-by: Rohit Jaini <rjaini@microsoft.com> Co-authored-by: larisaborodina <larisab@microsoft.com> Co-authored-by: larisaborodina <58491292+larisaborodina@users.noreply.github.com>
1 parent 9b5c309 commit c5e5d38

File tree

47 files changed

+3877
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+3877
-0
lines changed

‎src/Azs.ContainerRegistry.Admin/docs/Azs.ContainerRegistry.Admin.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
Module Name: Azs.ContainerRegistry.Admin
3+
Module Guid: 27950488-3e83-458b-8797-6db82864cf62
4+
Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azs.containerregistry.admin
5+
Help Version: 1.0.0.0
6+
Locale: en-US
7+
---
8+
9+
# Azs.ContainerRegistry.Admin Module
10+
## Description
11+
Microsoft AzureStack PowerShell: ContainerRegistry Admin cmdlets
12+
13+
## Azs.ContainerRegistry.Admin Cmdlets
14+
### [Get-AzsContainerRegistry](Get-AzsContainerRegistry.md)
15+
Returns a list of container registries present in all tenant location.
16+
17+
### [Get-AzsContainerRegistryCapacity](Get-AzsContainerRegistryCapacity.md)
18+
Returns container registry capacity property.
19+
20+
### [Get-AzsContainerRegistryConfiguration](Get-AzsContainerRegistryConfiguration.md)
21+
Returns the specified configuration details.
22+
23+
### [Get-AzsContainerRegistryQuota](Get-AzsContainerRegistryQuota.md)
24+
Returns the specified container registry quota.
25+
26+
### [Get-AzsContainerRegistrySetupStatus](Get-AzsContainerRegistrySetupStatus.md)
27+
Returns the status of the container registry setup.
28+
29+
### [New-AzsContainerRegistryQuota](New-AzsContainerRegistryQuota.md)
30+
Create or update an existing container registry quota.
31+
32+
### [Remove-AzsContainerRegistryConfiguration](Remove-AzsContainerRegistryConfiguration.md)
33+
Delete an existing container registry configuration
34+
35+
### [Remove-AzsContainerRegistryQuota](Remove-AzsContainerRegistryQuota.md)
36+
Delete an existing container registry quota
37+
38+
### [Set-AzsContainerRegistryConfiguration](Set-AzsContainerRegistryConfiguration.md)
39+
Configure container registry overall configuration properties.
40+
41+
### [Set-AzsContainerRegistryQuota](Set-AzsContainerRegistryQuota.md)
42+
Create or update an existing container registry quota.
43+
44+
### [Start-AzsContainerRegistrySetup](Start-AzsContainerRegistrySetup.md)
45+
Invokes container registry certificate uploading and service deployment.
46+

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

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
external help file:
3+
Module Name: Azs.ContainerRegistry.Admin
4+
online version: https://docs.microsoft.com/en-us/powershell/module/azs.containerregistry.admin/get-azscontainerregistry
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzsContainerRegistry
9+
10+
## SYNOPSIS
11+
Returns a list of container registries present in all tenant location.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-AzsContainerRegistry [-Location <String>] [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>]
17+
[<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
Returns a list of container registries present in all tenant location.
22+
23+
## EXAMPLES
24+
25+
### -------------------------- EXAMPLE 1 --------------------------
26+
```powershell
27+
Get-AzsContainerRegistry
28+
```
29+
30+
{
31+
"CreationDate": "\/Date(1629160842681)\/",
32+
"Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/registries/testregistry01",
33+
"Location": "redmond",
34+
"Name": "redmond/testregistry01",
35+
"PropertiesName": "testregistry01",
36+
"RegistryId": "/subscriptions/72b77b1b-3e43-4d00-8b5b-be6beceb7f3a/resourceGroups/acrtenanttestrg/providers/Microsoft.ContainerRegistry/registries/testregistry01",
37+
"RegistrySizeInByte": 3011,
38+
"ResourceGroup": "acrtenanttestrg",
39+
"SubscriptionId": "72b77b1b-3e43-4d00-8b5b-be6beceb7f3a",
40+
"Type": "Microsoft.ContainerRegistry.Admin/locations/registries"
41+
}
42+
43+
## PARAMETERS
44+
45+
### -DefaultProfile
46+
The credentials, account, tenant, and subscription used for communication with Azure.
47+
48+
```yaml
49+
Type: System.Management.Automation.PSObject
50+
Parameter Sets: (All)
51+
Aliases: AzureRMContext, AzureCredential
52+
53+
Required: False
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -Location
61+
The name of Azure region.
62+
63+
```yaml
64+
Type: System.String
65+
Parameter Sets: (All)
66+
Aliases:
67+
68+
Required: False
69+
Position: Named
70+
Default value: (Get-AzLocation)[0].Location
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
### -SubscriptionId
76+
The ID of the target subscription.
77+
78+
```yaml
79+
Type: System.String[]
80+
Parameter Sets: (All)
81+
Aliases:
82+
83+
Required: False
84+
Position: Named
85+
Default value: (Get-AzContext).Subscription.Id
86+
Accept pipeline input: False
87+
Accept wildcard characters: False
88+
```
89+
90+
### CommonParameters
91+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
92+
93+
## INPUTS
94+
95+
## OUTPUTS
96+
97+
### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistryAdmin.Models.Api20191101Preview.IContainerRegistry
98+
99+
## NOTES
100+
101+
ALIASES
102+
103+
## RELATED LINKS
104+

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

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
---
2+
external help file:
3+
Module Name: Azs.ContainerRegistry.Admin
4+
online version: https://docs.microsoft.com/en-us/powershell/module/azs.containerregistry.admin/get-azscontainerregistrycapacity
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzsContainerRegistryCapacity
9+
10+
## SYNOPSIS
11+
Returns container registry capacity property.
12+
13+
## SYNTAX
14+
15+
### List (Default)
16+
```
17+
Get-AzsContainerRegistryCapacity [-Location <String>] [-SubscriptionId <String[]>]
18+
[-DefaultProfile <PSObject>] [<CommonParameters>]
19+
```
20+
21+
### Get
22+
```
23+
Get-AzsContainerRegistryCapacity -CapacityName <String> [-Location <String>] [-SubscriptionId <String[]>]
24+
[-DefaultProfile <PSObject>] [<CommonParameters>]
25+
```
26+
27+
### GetViaIdentity
28+
```
29+
Get-AzsContainerRegistryCapacity -InputObject <IContainerRegistryAdminIdentity> [-DefaultProfile <PSObject>]
30+
[<CommonParameters>]
31+
```
32+
33+
## DESCRIPTION
34+
Returns container registry capacity property.
35+
36+
## EXAMPLES
37+
38+
### -------------------------- EXAMPLE 1 --------------------------
39+
```powershell
40+
Get-AzsContainerRegistryCapacity
41+
```
42+
43+
{
44+
"AllowPush": true,
45+
"Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/capacities/Default",
46+
"MaximumCapacityInGiB": 2000,
47+
"Name": "redmond/Default",
48+
"RegistriesConsumptionInGiB": 0,
49+
"Type": "Microsoft.ContainerRegistry.Admin/locations/capacities"
50+
}
51+
52+
## PARAMETERS
53+
54+
### -CapacityName
55+
The name of the capacity parameter.
56+
57+
```yaml
58+
Type: System.String
59+
Parameter Sets: Get
60+
Aliases:
61+
62+
Required: True
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### -DefaultProfile
70+
The credentials, account, tenant, and subscription used for communication with Azure.
71+
72+
```yaml
73+
Type: System.Management.Automation.PSObject
74+
Parameter Sets: (All)
75+
Aliases: AzureRMContext, AzureCredential
76+
77+
Required: False
78+
Position: Named
79+
Default value: None
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
### -InputObject
85+
Identity Parameter
86+
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
87+
88+
```yaml
89+
Type: Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistryAdmin.Models.IContainerRegistryAdminIdentity
90+
Parameter Sets: GetViaIdentity
91+
Aliases:
92+
93+
Required: True
94+
Position: Named
95+
Default value: None
96+
Accept pipeline input: True (ByValue)
97+
Accept wildcard characters: False
98+
```
99+
100+
### -Location
101+
The name of Azure region.
102+
103+
```yaml
104+
Type: System.String
105+
Parameter Sets: Get, List
106+
Aliases:
107+
108+
Required: False
109+
Position: Named
110+
Default value: (Get-AzLocation)[0].Location
111+
Accept pipeline input: False
112+
Accept wildcard characters: False
113+
```
114+
115+
### -SubscriptionId
116+
The ID of the target subscription.
117+
118+
```yaml
119+
Type: System.String[]
120+
Parameter Sets: Get, List
121+
Aliases:
122+
123+
Required: False
124+
Position: Named
125+
Default value: (Get-AzContext).Subscription.Id
126+
Accept pipeline input: False
127+
Accept wildcard characters: False
128+
```
129+
130+
### CommonParameters
131+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
132+
133+
## INPUTS
134+
135+
### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistryAdmin.Models.IContainerRegistryAdminIdentity
136+
137+
## OUTPUTS
138+
139+
### Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistryAdmin.Models.Api20191101Preview.IContainerRegistryCapacity
140+
141+
## NOTES
142+
143+
ALIASES
144+
145+
COMPLEX PARAMETER PROPERTIES
146+
147+
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
148+
149+
150+
INPUTOBJECT <IContainerRegistryAdminIdentity>: Identity Parameter
151+
- `[CapacityName <String>]`: The name of the capacity parameter.
152+
- `[ConfigurationName <String>]`: The name of the configuration.
153+
- `[Id <String>]`: Resource identity path
154+
- `[Location <String>]`: The name of Azure region.
155+
- `[QuotaName <String>]`: The name of the container registry quota.
156+
- `[SubscriptionId <String>]`: The ID of the target subscription.
157+
158+
## RELATED LINKS
159+

0 commit comments

Comments
 (0)