From 5f81725cf7bf9e19b4e5d5ff97378ddf786e4e83 Mon Sep 17 00:00:00 2001 From: larisaborodina Date: Mon, 16 Aug 2021 18:04:44 -0700 Subject: [PATCH] Add examples for all the cmdlets. --- .../Get-AzsContainerRegistryCapacity.md | 16 ++++++++ .../Get-AzsContainerRegistryConfiguration.md | 15 +++++++ .../examples/Get-AzsContainerRegistryQuota.md | 39 +++++++++++++++++++ .../Get-AzsContainerRegistrySetupStatus.md | 16 ++++++++ .../examples/New-AzsContainerRegistryQuota.md | 15 +++++++ .../examples/Read-AzsContainerRegistry.md | 19 +++++++++ ...emove-AzsContainerRegistryConfiguration.md | 7 ++++ .../Remove-AzsContainerRegistryQuota.md | 7 ++++ .../Set-AzsContainerRegistryConfiguration.md | 14 +++++++ .../examples/Set-AzsContainerRegistryQuota.md | 15 +++++++ .../Start-AzsContainerRegistrySetup.md | 8 ++++ 11 files changed, 171 insertions(+) create mode 100644 src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryCapacity.md create mode 100644 src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryConfiguration.md create mode 100644 src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryQuota.md create mode 100644 src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistrySetupStatus.md create mode 100644 src/Azs.ContainerRegistry.Admin/examples/New-AzsContainerRegistryQuota.md create mode 100644 src/Azs.ContainerRegistry.Admin/examples/Read-AzsContainerRegistry.md create mode 100644 src/Azs.ContainerRegistry.Admin/examples/Remove-AzsContainerRegistryConfiguration.md create mode 100644 src/Azs.ContainerRegistry.Admin/examples/Remove-AzsContainerRegistryQuota.md create mode 100644 src/Azs.ContainerRegistry.Admin/examples/Set-AzsContainerRegistryConfiguration.md create mode 100644 src/Azs.ContainerRegistry.Admin/examples/Set-AzsContainerRegistryQuota.md create mode 100644 src/Azs.ContainerRegistry.Admin/examples/Start-AzsContainerRegistrySetup.md diff --git a/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryCapacity.md b/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryCapacity.md new file mode 100644 index 00000000..6795c54e --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryCapacity.md @@ -0,0 +1,16 @@ +### Example 1: Get Azs ContainerRegistry Capacity +```powershell +PS C:\> Get-AzsContainerRegistryCapacity + +{ + "AllowPush": true, + "Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/capacities/Default", + "MaximumCapacityInGiB": 2000, + "Name": "redmond/Default", + "RegistriesConsumptionInGiB": 0, + "Type": "Microsoft.ContainerRegistry.Admin/locations/capacities" +} +``` + +Returns container registry capacity property. + diff --git a/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryConfiguration.md b/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryConfiguration.md new file mode 100644 index 00000000..cec2abea --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryConfiguration.md @@ -0,0 +1,15 @@ +### Example 1: Get AzsContainerRegistry Configuration +```powershell +PS C:\> Get-AzsContainerRegistryConfiguration + +{{ + "Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/configurations/Default", + "MaximumCapacityInGiB": 2000, + "Name": "redmond/Default", + "Type": "Microsoft.ContainerRegistry.Admin/locations/configurations" +} +``` + +Returns the specified configuration details. + + diff --git a/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryQuota.md b/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryQuota.md new file mode 100644 index 00000000..96031498 --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistryQuota.md @@ -0,0 +1,39 @@ +### Example 1: Get List Azs ContainerRegistry Quotas +```powershell +PS C:\> Get-AzsContainerRegistryQuota + +[ + { + "CapacityPerRegistryInGiB": 20, + "Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/quotas/Default quota", + "Name": "redmond/Default quota", + "NumberOfRegistry": 20, + "Type": "Microsoft.ContainerRegistry.Admin/locations/quotas" + }, + { + "CapacityPerRegistryInGiB": 30, + "Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/quotas/testquota", + "Name": "redmond/testquota", + "NumberOfRegistry": 30, + "Type": "Microsoft.ContainerRegistry.Admin/locations/quotas" + } +] +``` + +Returns a list of container registry quotas at the given location. + +### Example 2: Get Azs ContainerRegistry Quota by Name +```powershell +PS C:\> Get-AzsContainerRegistryQuota -Name "Default quota" + +{ + "CapacityPerRegistryInGiB": 20, + "Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/quotas/Default quota", + "Name": "redmond/Default quota", + "NumberOfRegistry": 20, + "Type": "Microsoft.ContainerRegistry.Admin/locations/quotas" +} +``` + +Returns the specified container registry quota. + diff --git a/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistrySetupStatus.md b/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistrySetupStatus.md new file mode 100644 index 00000000..b77472ba --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/Get-AzsContainerRegistrySetupStatus.md @@ -0,0 +1,16 @@ +### Example 1: Get Azs ContainerRegistry Setup Status +```powershell +PS C:\> Get-AzsContainerRegistrySetupStatus + +{ + "id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Setup/locations/redmond/setup/value", + "name": "redmond/value", + "type": "Microsoft.ContainerRegistry.Setup/locations/setup", + "properties": { + "status": "Completed" + } +} +``` + +Returns the status of the container registry setup. + diff --git a/src/Azs.ContainerRegistry.Admin/examples/New-AzsContainerRegistryQuota.md b/src/Azs.ContainerRegistry.Admin/examples/New-AzsContainerRegistryQuota.md new file mode 100644 index 00000000..2741160c --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/New-AzsContainerRegistryQuota.md @@ -0,0 +1,15 @@ +### Example 1: New Azs ContainerRegistry Quota +```powershell +PS C:\> New-AzsContainerRegistryQuota -QuotaName testquota -CapacityPerRegistryInGib 20 -NumberOfRegistry 20 + +{ + "CapacityPerRegistryInGiB": 20, + "Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/quotas/testquota", + "Name": "redmond/testquota", + "NumberOfRegistry": 20, + "Type": "Microsoft.ContainerRegistry.Admin/locations/quotas" +} +``` + +Create or update an existing container registry quota. + diff --git a/src/Azs.ContainerRegistry.Admin/examples/Read-AzsContainerRegistry.md b/src/Azs.ContainerRegistry.Admin/examples/Read-AzsContainerRegistry.md new file mode 100644 index 00000000..f9071f49 --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/Read-AzsContainerRegistry.md @@ -0,0 +1,19 @@ +### Example 1: Read List Azs Container Registries +```powershell +PS C:\> Read-AzsContainerRegistry + +{ + "CreationDate": "\/Date(1629160842681)\/", + "Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/registries/testregistry01", + "Location": "redmond", + "Name": "redmond/testregistry01", + "PropertiesName": "testregistry01", + "RegistryId": "/subscriptions/72b77b1b-3e43-4d00-8b5b-be6beceb7f3a/resourceGroups/acrtenanttestrg/providers/Microsoft.ContainerRegistry/registries/testregistry01", + "RegistrySizeInByte": 3011, + "ResourceGroup": "acrtenanttestrg", + "SubscriptionId": "72b77b1b-3e43-4d00-8b5b-be6beceb7f3a", + "Type": "Microsoft.ContainerRegistry.Admin/locations/registries" +} +``` + +Returns a list of container registries present in all tenant location. diff --git a/src/Azs.ContainerRegistry.Admin/examples/Remove-AzsContainerRegistryConfiguration.md b/src/Azs.ContainerRegistry.Admin/examples/Remove-AzsContainerRegistryConfiguration.md new file mode 100644 index 00000000..86bb1fa0 --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/Remove-AzsContainerRegistryConfiguration.md @@ -0,0 +1,7 @@ +### Example 1: Remove Azs ContainerRegistry Configuration +```powershell +PS C:\> Remove-AzsContainerRegistryConfiguration -ConfigurationName default + +``` + +Delete an existing container registry configuration. \ No newline at end of file diff --git a/src/Azs.ContainerRegistry.Admin/examples/Remove-AzsContainerRegistryQuota.md b/src/Azs.ContainerRegistry.Admin/examples/Remove-AzsContainerRegistryQuota.md new file mode 100644 index 00000000..4043c635 --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/Remove-AzsContainerRegistryQuota.md @@ -0,0 +1,7 @@ +### Example 1: Remove Azs ContainerRegistry Configuration +```powershell +PS C:\> Remove-AzsContainerRegistryConfiguration -ConfigurationName default + +``` + +Delete an existing container registry configuration. diff --git a/src/Azs.ContainerRegistry.Admin/examples/Set-AzsContainerRegistryConfiguration.md b/src/Azs.ContainerRegistry.Admin/examples/Set-AzsContainerRegistryConfiguration.md new file mode 100644 index 00000000..54e44dd8 --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/Set-AzsContainerRegistryConfiguration.md @@ -0,0 +1,14 @@ +### Example 1: Set Azs ContainerRegistry Configuration +```powershell +PS C:\> Set-AzsContainerRegistryConfiguration -MaximumCapacityInGib 30 -ConfigurationName default + +{ + "Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/configurations/Default", + "MaximumCapacityInGiB": 30, + "Name": "redmond/Default", + "Type": "Microsoft.ContainerRegistry.Admin/locations/configurations" +} +``` + +Configure container registry overall configuration properties. + diff --git a/src/Azs.ContainerRegistry.Admin/examples/Set-AzsContainerRegistryQuota.md b/src/Azs.ContainerRegistry.Admin/examples/Set-AzsContainerRegistryQuota.md new file mode 100644 index 00000000..1d189538 --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/Set-AzsContainerRegistryQuota.md @@ -0,0 +1,15 @@ +### Example 1: Set Azs ContainerRegistry Quota +```powershell +PS C:\> Set-AzsContainerRegistryQuota -QuotaName testquota -CapacityPerRegistryInGib 30 -NumberOfRegistry 30 + +{ + "CapacityPerRegistryInGiB": 30, + "Id": "/subscriptions/7e41090c-4aa7-40bc-856a-a993f8fbd215/providers/Microsoft.ContainerRegistry.Admin/locations/redmond/quotas/testquota", + "Name": "redmond/testquota", + "NumberOfRegistry": 30, + "Type": "Microsoft.ContainerRegistry.Admin/locations/quotas" +} +``` + +Update an existing container registry quota. + diff --git a/src/Azs.ContainerRegistry.Admin/examples/Start-AzsContainerRegistrySetup.md b/src/Azs.ContainerRegistry.Admin/examples/Start-AzsContainerRegistrySetup.md new file mode 100644 index 00000000..6fec9ee6 --- /dev/null +++ b/src/Azs.ContainerRegistry.Admin/examples/Start-AzsContainerRegistrySetup.md @@ -0,0 +1,8 @@ +### Example 1: Start Azs ContainerRegistry Setup +```powershell +PS C:\> Start-AzsContainerRegistrySetup -Password $password -SslCertInputFile $pfx_cert_path + +``` + +Invokes container registry certificate uploading and service deployment. +