Skip to content

Commit 2aa45f4

Browse files
bganapabganapa
authored
Merge pull request Azure#11 from ionuttulai/user/iotulai/azurebridge
AzureBridge - unit tests, docs and examples
2 parents 6d1b5ea + 2aac121 commit 2aa45f4

18 files changed

+1143
-2
lines changed

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
Module Name: Azs.AzureBridge.Admin
3+
Module Guid: 82d2260a-95ae-44bb-af8b-afd67d38f6db
4+
Download Help Link: {{Please enter FwLink manually}}
5+
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
6+
Locale: en-US
7+
---
8+
9+
# Azs.AzureBridge.Admin Module
10+
## Description
11+
Preview release of the AzureStack AzureBridge operator module which allows you to manage your AzureStack marketplace items.
12+
13+
## Azs.AzureBridge.Admin Cmdlets
14+
### [Get-AzsAzureBridgeActivation](Get-AzsAzureBridgeActivation.md)
15+
Returns the Azure Bridge Activation.
16+
17+
### [Get-AzsAzureBridgeDownloadedProduct](Get-AzsAzureBridgeDownloadedProduct.md)
18+
Returns a list of products downloaded from Azure MarketPlace.
19+
20+
### [Get-AzsAzureBridgeProduct](Get-AzsAzureBridgeProduct.md)
21+
Returns a list of products available for download from Azure Marketplace.
22+
23+
### [Invoke-AzsAzureBridgeProductDownload](Invoke-AzsAzureBridgeProductDownload.md)
24+
Downloads a product from azure marketplace.
25+
26+
### [Remove-AzsAzureBridgeDownloadedProduct](Remove-AzsAzureBridgeDownloadedProduct.md)
27+
Delete a product downloaded from Azure MarketPlace.
28+

‎src/Azs.AzureBridge.Admin/docs/Get-AzsAzureBridgeActivation.md

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
external help file: Azs.Azurebridge.Admin-help.xml
3+
Module Name: Azs.AzureBridge.Admin
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzsAzureBridgeActivation
9+
10+
## SYNOPSIS
11+
Returns the Azure Bridge Activation.
12+
13+
## SYNTAX
14+
15+
### List (Default)
16+
```
17+
Get-AzsAzureBridgeActivation -ResourceGroupName <String> [-Skip <Int32>] [-Top <Int32>] [<CommonParameters>]
18+
```
19+
20+
### Get
21+
```
22+
Get-AzsAzureBridgeActivation -Name <String> -ResourceGroupName <String> [<CommonParameters>]
23+
```
24+
25+
### ResourceId
26+
```
27+
Get-AzsAzureBridgeActivation -ResourceId <String> [<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
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.
32+
33+
## EXAMPLES
34+
35+
### -------------------------- EXAMPLE 1 --------------------------
36+
```
37+
Get-AzsAzureBridgeActivation -ResourceGroupName 'activationRG'
38+
```
39+
40+
Get a list of Azure Bridge Activations under the resource group "activationRG"
41+
42+
### -------------------------- EXAMPLE 2 --------------------------
43+
```
44+
Get-AzsAzureBridgeActivation -Name 'myActivation' -ResourceGroupName 'activationRG'
45+
```
46+
47+
Get an Azure Bridge Activation by name 'myActivation' situated under 'activationRG'
48+
49+
## PARAMETERS
50+
51+
### -Name
52+
Name of the activation.
53+
54+
```yaml
55+
Type: String
56+
Parameter Sets: Get
57+
Aliases:
58+
59+
Required: True
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -ResourceGroupName
67+
The Resource Group used during the registration of Azure Stack; you can also view Resource Group names in the portal.
68+
69+
```yaml
70+
Type: String
71+
Parameter Sets: List, Get
72+
Aliases:
73+
74+
Required: True
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -ResourceId
82+
The resource id.
83+
84+
```yaml
85+
Type: String
86+
Parameter Sets: ResourceId
87+
Aliases: id
88+
89+
Required: True
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: True (ByPropertyName)
93+
Accept wildcard characters: False
94+
```
95+
96+
### -Skip
97+
Skip the first N items as specified by the parameter value.
98+
99+
```yaml
100+
Type: Int32
101+
Parameter Sets: List
102+
Aliases:
103+
104+
Required: False
105+
Position: Named
106+
Default value: -1
107+
Accept pipeline input: False
108+
Accept wildcard characters: False
109+
```
110+
111+
### -Top
112+
Return the top N items as specified by the parameter value.
113+
Applies after the -Skip parameter.
114+
115+
```yaml
116+
Type: Int32
117+
Parameter Sets: List
118+
Aliases:
119+
120+
Required: False
121+
Position: Named
122+
Default value: -1
123+
Accept pipeline input: False
124+
Accept wildcard characters: False
125+
```
126+
127+
### CommonParameters
128+
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).
129+
130+
## INPUTS
131+
132+
## OUTPUTS
133+
134+
### Microsoft.AzureStack.Management.AzureBridge.Admin.Models.ActivationResource
135+
136+
## NOTES
137+
138+
## RELATED LINKS
139+

‎src/Azs.AzureBridge.Admin/docs/Get-AzsAzureBridgeDownloadedProduct.md

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
external help file: Azs.Azurebridge.Admin-help.xml
3+
Module Name: Azs.AzureBridge.Admin
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzsAzureBridgeDownloadedProduct
9+
10+
## SYNOPSIS
11+
Returns a list of products downloaded from Azure MarketPlace.
12+
13+
## SYNTAX
14+
15+
### List (Default)
16+
```
17+
Get-AzsAzureBridgeDownloadedProduct -ActivationName <String> -ResourceGroupName <String> [-Skip <Int32>]
18+
[-Top <Int32>] [<CommonParameters>]
19+
```
20+
21+
### Get
22+
```
23+
Get-AzsAzureBridgeDownloadedProduct -Name <String> -ActivationName <String> -ResourceGroupName <String>
24+
[<CommonParameters>]
25+
```
26+
27+
### ResourceId
28+
```
29+
Get-AzsAzureBridgeDownloadedProduct -ResourceId <String> [<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
Returns a list of products downloaded from Azure MarketPlace.
34+
35+
## EXAMPLES
36+
37+
### -------------------------- EXAMPLE 1 --------------------------
38+
```
39+
Get-AzsAzureBridgeDownloadedProduct -ActivationName 'myActivation' -ResourceGroupName 'activationRG'
40+
```
41+
42+
Get a list of Azure Bridge Downloaded products
43+
44+
### -------------------------- EXAMPLE 2 --------------------------
45+
```
46+
Get-AzsAzureBridgeDownloadedProduct -Name 'microsoft.docker-arm.1.1.0' -ActivationName 'myActivation' -ResourceGroupName 'activationRG'
47+
```
48+
49+
Get an Azure Bridge Downloaded Product by Name
50+
51+
## PARAMETERS
52+
53+
### -ActivationName
54+
Name of the activation.
55+
56+
```yaml
57+
Type: String
58+
Parameter Sets: List, Get
59+
Aliases:
60+
61+
Required: True
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
### -Name
69+
Name of the product.
70+
71+
```yaml
72+
Type: String
73+
Parameter Sets: Get
74+
Aliases:
75+
76+
Required: True
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
83+
### -ResourceGroupName
84+
The resource group the resource is located under.
85+
86+
```yaml
87+
Type: String
88+
Parameter Sets: List, Get
89+
Aliases:
90+
91+
Required: True
92+
Position: Named
93+
Default value: None
94+
Accept pipeline input: False
95+
Accept wildcard characters: False
96+
```
97+
98+
### -ResourceId
99+
The resource id.
100+
101+
```yaml
102+
Type: String
103+
Parameter Sets: ResourceId
104+
Aliases: id
105+
106+
Required: True
107+
Position: Named
108+
Default value: None
109+
Accept pipeline input: True (ByPropertyName)
110+
Accept wildcard characters: False
111+
```
112+
113+
### -Skip
114+
Skip the first N items as specified by the parameter value.
115+
116+
```yaml
117+
Type: Int32
118+
Parameter Sets: List
119+
Aliases:
120+
121+
Required: False
122+
Position: Named
123+
Default value: -1
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### -Top
129+
Return the top N items as specified by the parameter value.
130+
Applies after the -Skip parameter.
131+
132+
```yaml
133+
Type: Int32
134+
Parameter Sets: List
135+
Aliases:
136+
137+
Required: False
138+
Position: Named
139+
Default value: -1
140+
Accept pipeline input: False
141+
Accept wildcard characters: False
142+
```
143+
144+
### CommonParameters
145+
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).
146+
147+
## INPUTS
148+
149+
## OUTPUTS
150+
151+
### Microsoft.AzureStack.Management.AzureBridge.Admin.Models.DownloadedProductResource
152+
153+
## NOTES
154+
155+
## RELATED LINKS
156+

0 commit comments

Comments
 (0)