Skip to content

Commit dc4cbfa

Browse files
VSC CI Serviceappveyor
authored andcommitted
Update azure powershell docs.
1 parent dfeec56 commit dc4cbfa

File tree

2,114 files changed

+416994
-92
lines changed

Some content is hidden

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

2,114 files changed

+416994
-92
lines changed
Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
---
2+
external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml
3+
ms.assetid: 7C86B385-D784-45FD-9B57-31C895115A2C
4+
online version:
5+
schema: 2.0.0
6+
updated_at: 1/11/2017 9:26 PM
7+
ms.date: 1/11/2017
8+
content_git_url: https://github.com/Azure/azure-docs-powershell/blob/master/azureps-cmdlets-docs/ResourceManager/AzureRM.ApiManagement/v3.2.0/Add-AzureRmApiManagementApiToProduct.md
9+
original_content_git_url: https://github.com/Azure/azure-docs-powershell/blob/master/azureps-cmdlets-docs/ResourceManager/AzureRM.ApiManagement/v3.2.0/Add-AzureRmApiManagementApiToProduct.md
10+
gitcommit: https://github.com/Azure/azure-docs-powershell/blob/cf5fb15dcd1fe2c86458f47e1a11dc88817021fc/azureps-cmdlets-docs/ResourceManager/AzureRM.ApiManagement/v3.2.0/Add-AzureRmApiManagementApiToProduct.md
11+
ms.topic: reference
12+
ms.prod: powershell
13+
ms.technology: Azure PowerShell
14+
author: erickson-doug
15+
ms.author: PowerShellHelpPub
16+
keywords: powershell, cmdlet
17+
manager: erickson-doug
18+
open_to_public_contributors: False
19+
ms.service: azure-powershell
20+
---
21+
22+
# Add-AzureRmApiManagementApiToProduct
23+
24+
## SYNOPSIS
25+
Adds an API to a product.
26+
27+
## SYNTAX
28+
29+
```
30+
Add-AzureRmApiManagementApiToProduct -Context <PsApiManagementContext> -ProductId <String> -ApiId <String>
31+
[-PassThru] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
32+
```
33+
34+
## DESCRIPTION
35+
The **Add-AzureRmApiManagementApiToProduct** cmdlet adds an Azure API Management API to a product.
36+
37+
## EXAMPLES
38+
39+
### Example 1: Add an API to a product
40+
```
41+
PS C:\>Add-AzureRmApiManagementApiToProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001"
42+
```
43+
44+
This command adds the specified API to the specified product.
45+
46+
## PARAMETERS
47+
48+
### -ApiId
49+
Specifies the ID of an API to add to a product.
50+
51+
```yaml
52+
Type: String
53+
Parameter Sets: (All)
54+
Aliases:
55+
56+
Required: True
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: True (ByPropertyName)
60+
Accept wildcard characters: False
61+
```
62+
63+
### -Context
64+
Specifies a **PsApiManagementContext** object.
65+
66+
```yaml
67+
Type: PsApiManagementContext
68+
Parameter Sets: (All)
69+
Aliases:
70+
71+
Required: True
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: True (ByPropertyName)
75+
Accept wildcard characters: False
76+
```
77+
78+
### -InformationAction
79+
Specifies how this cmdlet responds to an information event.
80+
81+
The acceptable values for this parameter are:
82+
83+
- Continue
84+
- Ignore
85+
- Inquire
86+
- SilentlyContinue
87+
- Stop
88+
- Suspend
89+
90+
```yaml
91+
Type: ActionPreference
92+
Parameter Sets: (All)
93+
Aliases: infa
94+
95+
Required: False
96+
Position: Named
97+
Default value: None
98+
Accept pipeline input: False
99+
Accept wildcard characters: False
100+
```
101+
102+
### -InformationVariable
103+
Specifies an information variable.
104+
105+
```yaml
106+
Type: String
107+
Parameter Sets: (All)
108+
Aliases: iv
109+
110+
Required: False
111+
Position: Named
112+
Default value: None
113+
Accept pipeline input: False
114+
Accept wildcard characters: False
115+
```
116+
117+
### -PassThru
118+
Returns an object representing the item with which you are working.
119+
By default, this cmdlet does not generate any output.
120+
121+
```yaml
122+
Type: SwitchParameter
123+
Parameter Sets: (All)
124+
Aliases:
125+
126+
Required: False
127+
Position: Named
128+
Default value: None
129+
Accept pipeline input: True (ByPropertyName)
130+
Accept wildcard characters: False
131+
```
132+
133+
### -ProductId
134+
Specifies the ID of the product to which to add the API.
135+
136+
```yaml
137+
Type: String
138+
Parameter Sets: (All)
139+
Aliases:
140+
141+
Required: True
142+
Position: Named
143+
Default value: None
144+
Accept pipeline input: True (ByPropertyName)
145+
Accept wildcard characters: False
146+
```
147+
148+
### CommonParameters
149+
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).
150+
151+
## INPUTS
152+
153+
## OUTPUTS
154+
155+
### Boolean
156+
157+
## NOTES
158+
159+
## RELATED LINKS
160+
161+
[Remove-AzureRmApiManagementApiFromProduct](xref:ResourceManager/AzureRM.ApiManagement/v3.2.0/Remove-AzureRmApiManagementApiFromProduct.md)
162+
163+
Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
external help file: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml
3+
ms.assetid: 1058BA4E-CD79-429D-BB05-422AE39230C4
4+
online version:
5+
schema: 2.0.0
6+
updated_at: 1/11/2017 9:26 PM
7+
ms.date: 1/11/2017
8+
content_git_url: https://github.com/Azure/azure-docs-powershell/blob/master/azureps-cmdlets-docs/ResourceManager/AzureRM.ApiManagement/v3.2.0/Add-AzureRmApiManagementProductToGroup.md
9+
original_content_git_url: https://github.com/Azure/azure-docs-powershell/blob/master/azureps-cmdlets-docs/ResourceManager/AzureRM.ApiManagement/v3.2.0/Add-AzureRmApiManagementProductToGroup.md
10+
gitcommit: https://github.com/Azure/azure-docs-powershell/blob/cf5fb15dcd1fe2c86458f47e1a11dc88817021fc/azureps-cmdlets-docs/ResourceManager/AzureRM.ApiManagement/v3.2.0/Add-AzureRmApiManagementProductToGroup.md
11+
ms.topic: reference
12+
ms.prod: powershell
13+
ms.technology: Azure PowerShell
14+
author: erickson-doug
15+
ms.author: PowerShellHelpPub
16+
keywords: powershell, cmdlet
17+
manager: erickson-doug
18+
open_to_public_contributors: False
19+
ms.service: azure-powershell
20+
---
21+
22+
# Add-AzureRmApiManagementProductToGroup
23+
24+
## SYNOPSIS
25+
Adds a product to a group.
26+
27+
## SYNTAX
28+
29+
```
30+
Add-AzureRmApiManagementProductToGroup -Context <PsApiManagementContext> -GroupId <String> -ProductId <String>
31+
[-PassThru] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
32+
```
33+
34+
## DESCRIPTION
35+
The **Add-AzureRmApiManagementProductToGroup** cmdlet adds a product to an existing group.
36+
In other words, this cmdlet assigns a group to a product.
37+
38+
## EXAMPLES
39+
40+
### Example 1: Add a product to a group
41+
```
42+
PS C:\>Add-AzureRmApiManagementProductToGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789"
43+
```
44+
45+
This command adds a product to an existing group.
46+
47+
## PARAMETERS
48+
49+
### -Context
50+
Specifies a **PsApiManagementContext** object.
51+
This parameter is required.
52+
53+
```yaml
54+
Type: PsApiManagementContext
55+
Parameter Sets: (All)
56+
Aliases:
57+
58+
Required: True
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: True (ByPropertyName)
62+
Accept wildcard characters: False
63+
```
64+
65+
### -GroupId
66+
Specifies the group ID.
67+
This parameter is required.
68+
69+
```yaml
70+
Type: String
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: True
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: True (ByPropertyName)
78+
Accept wildcard characters: False
79+
```
80+
81+
### -InformationAction
82+
Specifies how this cmdlet responds to an information event.
83+
84+
The acceptable values for this parameter are:
85+
86+
- Continue
87+
- Ignore
88+
- Inquire
89+
- SilentlyContinue
90+
- Stop
91+
- Suspend
92+
93+
```yaml
94+
Type: ActionPreference
95+
Parameter Sets: (All)
96+
Aliases: infa
97+
98+
Required: False
99+
Position: Named
100+
Default value: None
101+
Accept pipeline input: False
102+
Accept wildcard characters: False
103+
```
104+
105+
### -InformationVariable
106+
Specifies an information variable.
107+
108+
```yaml
109+
Type: String
110+
Parameter Sets: (All)
111+
Aliases: iv
112+
113+
Required: False
114+
Position: Named
115+
Default value: None
116+
Accept pipeline input: False
117+
Accept wildcard characters: False
118+
```
119+
120+
### -PassThru
121+
Returns an object representing the item with which you are working.
122+
By default, this cmdlet does not generate any output.
123+
124+
```yaml
125+
Type: SwitchParameter
126+
Parameter Sets: (All)
127+
Aliases:
128+
129+
Required: False
130+
Position: Named
131+
Default value: None
132+
Accept pipeline input: True (ByPropertyName)
133+
Accept wildcard characters: False
134+
```
135+
136+
### -ProductId
137+
Specifies the product ID.
138+
This parameter is required.
139+
140+
```yaml
141+
Type: String
142+
Parameter Sets: (All)
143+
Aliases:
144+
145+
Required: True
146+
Position: Named
147+
Default value: None
148+
Accept pipeline input: True (ByPropertyName)
149+
Accept wildcard characters: False
150+
```
151+
152+
### CommonParameters
153+
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).
154+
155+
## INPUTS
156+
157+
## OUTPUTS
158+
159+
### Boolean
160+
161+
## NOTES
162+
163+
## RELATED LINKS
164+
165+
[Remove-AzureRmApiManagementProductFromGroup](xref:ResourceManager/AzureRM.ApiManagement/v3.2.0/Remove-AzureRmApiManagementProductFromGroup.md)
166+
167+

0 commit comments

Comments
 (0)