forked from Azure/azure-powershell
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request Azure#11 from ionuttulai/user/iotulai/azurebridge
AzureBridge - unit tests, docs and examples
- Loading branch information
Showing
18 changed files
with
1,143 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
Module Name: Azs.AzureBridge.Admin | ||
Module Guid: 82d2260a-95ae-44bb-af8b-afd67d38f6db | ||
Download Help Link: {{Please enter FwLink manually}} | ||
Help Version: {{Please enter version of help manually (X.X.X.X) format}} | ||
Locale: en-US | ||
--- | ||
|
||
# Azs.AzureBridge.Admin Module | ||
## Description | ||
Preview release of the AzureStack AzureBridge operator module which allows you to manage your AzureStack marketplace items. | ||
|
||
## Azs.AzureBridge.Admin Cmdlets | ||
### [Get-AzsAzureBridgeActivation](Get-AzsAzureBridgeActivation.md) | ||
Returns the Azure Bridge Activation. | ||
|
||
### [Get-AzsAzureBridgeDownloadedProduct](Get-AzsAzureBridgeDownloadedProduct.md) | ||
Returns a list of products downloaded from Azure MarketPlace. | ||
|
||
### [Get-AzsAzureBridgeProduct](Get-AzsAzureBridgeProduct.md) | ||
Returns a list of products available for download from Azure Marketplace. | ||
|
||
### [Invoke-AzsAzureBridgeProductDownload](Invoke-AzsAzureBridgeProductDownload.md) | ||
Downloads a product from azure marketplace. | ||
|
||
### [Remove-AzsAzureBridgeDownloadedProduct](Remove-AzsAzureBridgeDownloadedProduct.md) | ||
Delete a product downloaded from Azure MarketPlace. | ||
|
139 changes: 139 additions & 0 deletions
139
src/Azs.AzureBridge.Admin/docs/Get-AzsAzureBridgeActivation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
--- | ||
external help file: Azs.Azurebridge.Admin-help.xml | ||
Module Name: Azs.AzureBridge.Admin | ||
online version: | ||
schema: 2.0.0 | ||
--- | ||
|
||
# Get-AzsAzureBridgeActivation | ||
|
||
## SYNOPSIS | ||
Returns the Azure Bridge Activation. | ||
|
||
## SYNTAX | ||
|
||
### List (Default) | ||
``` | ||
Get-AzsAzureBridgeActivation -ResourceGroupName <String> [-Skip <Int32>] [-Top <Int32>] [<CommonParameters>] | ||
``` | ||
|
||
### Get | ||
``` | ||
Get-AzsAzureBridgeActivation -Name <String> -ResourceGroupName <String> [<CommonParameters>] | ||
``` | ||
|
||
### ResourceId | ||
``` | ||
Get-AzsAzureBridgeActivation -ResourceId <String> [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
Once Azure Stack has been registered, the activation object contains information that links an Azure Stack deployment to its registration in Azure, for example, the registration expiration date, name, etc. | ||
|
||
## EXAMPLES | ||
|
||
### -------------------------- EXAMPLE 1 -------------------------- | ||
``` | ||
Get-AzsAzureBridgeActivation -ResourceGroupName 'activationRG' | ||
``` | ||
|
||
Get a list of Azure Bridge Activations under the resource group "activationRG" | ||
|
||
### -------------------------- EXAMPLE 2 -------------------------- | ||
``` | ||
Get-AzsAzureBridgeActivation -Name 'myActivation' -ResourceGroupName 'activationRG' | ||
``` | ||
|
||
Get an Azure Bridge Activation by name 'myActivation' situated under 'activationRG' | ||
|
||
## PARAMETERS | ||
|
||
### -Name | ||
Name of the activation. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: Get | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -ResourceGroupName | ||
The Resource Group used during the registration of Azure Stack; you can also view Resource Group names in the portal. | ||
```yaml | ||
Type: String | ||
Parameter Sets: List, Get | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -ResourceId | ||
The resource id. | ||
```yaml | ||
Type: String | ||
Parameter Sets: ResourceId | ||
Aliases: id | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: True (ByPropertyName) | ||
Accept wildcard characters: False | ||
``` | ||
### -Skip | ||
Skip the first N items as specified by the parameter value. | ||
```yaml | ||
Type: Int32 | ||
Parameter Sets: List | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: -1 | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Top | ||
Return the top N items as specified by the parameter value. | ||
Applies after the -Skip parameter. | ||
```yaml | ||
Type: Int32 | ||
Parameter Sets: List | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: -1 | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### CommonParameters | ||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). | ||
## INPUTS | ||
## OUTPUTS | ||
### Microsoft.AzureStack.Management.AzureBridge.Admin.Models.ActivationResource | ||
## NOTES | ||
## RELATED LINKS | ||
156 changes: 156 additions & 0 deletions
156
src/Azs.AzureBridge.Admin/docs/Get-AzsAzureBridgeDownloadedProduct.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,156 @@ | ||
--- | ||
external help file: Azs.Azurebridge.Admin-help.xml | ||
Module Name: Azs.AzureBridge.Admin | ||
online version: | ||
schema: 2.0.0 | ||
--- | ||
|
||
# Get-AzsAzureBridgeDownloadedProduct | ||
|
||
## SYNOPSIS | ||
Returns a list of products downloaded from Azure MarketPlace. | ||
|
||
## SYNTAX | ||
|
||
### List (Default) | ||
``` | ||
Get-AzsAzureBridgeDownloadedProduct -ActivationName <String> -ResourceGroupName <String> [-Skip <Int32>] | ||
[-Top <Int32>] [<CommonParameters>] | ||
``` | ||
|
||
### Get | ||
``` | ||
Get-AzsAzureBridgeDownloadedProduct -Name <String> -ActivationName <String> -ResourceGroupName <String> | ||
[<CommonParameters>] | ||
``` | ||
|
||
### ResourceId | ||
``` | ||
Get-AzsAzureBridgeDownloadedProduct -ResourceId <String> [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
Returns a list of products downloaded from Azure MarketPlace. | ||
|
||
## EXAMPLES | ||
|
||
### -------------------------- EXAMPLE 1 -------------------------- | ||
``` | ||
Get-AzsAzureBridgeDownloadedProduct -ActivationName 'myActivation' -ResourceGroupName 'activationRG' | ||
``` | ||
|
||
Get a list of Azure Bridge Downloaded products | ||
|
||
### -------------------------- EXAMPLE 2 -------------------------- | ||
``` | ||
Get-AzsAzureBridgeDownloadedProduct -Name 'microsoft.docker-arm.1.1.0' -ActivationName 'myActivation' -ResourceGroupName 'activationRG' | ||
``` | ||
|
||
Get an Azure Bridge Downloaded Product by Name | ||
|
||
## PARAMETERS | ||
|
||
### -ActivationName | ||
Name of the activation. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: List, Get | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Name | ||
Name of the product. | ||
```yaml | ||
Type: String | ||
Parameter Sets: Get | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -ResourceGroupName | ||
The resource group the resource is located under. | ||
```yaml | ||
Type: String | ||
Parameter Sets: List, Get | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -ResourceId | ||
The resource id. | ||
```yaml | ||
Type: String | ||
Parameter Sets: ResourceId | ||
Aliases: id | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: True (ByPropertyName) | ||
Accept wildcard characters: False | ||
``` | ||
### -Skip | ||
Skip the first N items as specified by the parameter value. | ||
```yaml | ||
Type: Int32 | ||
Parameter Sets: List | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: -1 | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Top | ||
Return the top N items as specified by the parameter value. | ||
Applies after the -Skip parameter. | ||
```yaml | ||
Type: Int32 | ||
Parameter Sets: List | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: -1 | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### CommonParameters | ||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). | ||
## INPUTS | ||
## OUTPUTS | ||
### Microsoft.AzureStack.Management.AzureBridge.Admin.Models.DownloadedProductResource | ||
## NOTES | ||
## RELATED LINKS | ||
Oops, something went wrong.