Skip to content

Commit 07828fb

Browse files
committed
Update all documentation for issue 4676
* Updated documentation for issue Azure#4676
1 parent 9aa8b2e commit 07828fb

File tree

91 files changed

+1748
-272
lines changed

Some content is hidden

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

91 files changed

+1748
-272
lines changed

src/ResourceManager/ApiManagement/ChangeLog.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@
1818
- Additional information about change #1
1919
-->
2020
## Current Release
21+
* Breaking Changes in Cmdlet to Manage Api Management Users
22+
- New-AzureRmApiManagementUser Parameter `Password` is changed from String to SecureString
23+
- Set-AzureRmApiManagementBackend Parameter `Password` is changed from String to SecureString
24+
25+
* Breaking Changes in Cmdlet to Create Backend Proxy Object
26+
- New-AzureRmApiManagementBackendProxy Parameter `Password` and `UserName` has been replaced with `ProxyCredentials` of type PSCredential
27+
28+
* Updated Cmdlet Get-AzureRmApiManagementUser to fix issue https://github.com/Azure/azure-powershell/issues/4510
29+
30+
* Updated Cmdlet New-AzureRmApiManagementApi to create Api with Empty Path https://github.com/Azure/azure-powershell/issues/4069
2131

2232
## Version 4.4.1
2333

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementApiToProduct.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Adds an API to a product.
1414

1515
```
1616
Add-AzureRmApiManagementApiToProduct -Context <PsApiManagementContext> -ProductId <String> -ApiId <String>
17-
[-PassThru] [<CommonParameters>]
17+
[-PassThru] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -24,6 +24,7 @@ The **Add-AzureRmApiManagementApiToProduct** cmdlet adds an Azure API Management
2424

2525
### Example 1: Add an API to a product
2626
```
27+
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
2728
PS C:\>Add-AzureRmApiManagementApiToProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001"
2829
```
2930

@@ -61,6 +62,21 @@ Accept pipeline input: True (ByPropertyName)
6162
Accept wildcard characters: False
6263
```
6364
65+
### -DefaultProfile
66+
The credentials, account, tenant, and subscription used for communication with azure.
67+
68+
```yaml
69+
Type: IAzureContextContainer
70+
Parameter Sets: (All)
71+
Aliases: AzureRmContext, AzureCredential
72+
73+
Required: False
74+
Position: Named
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
6480
### -PassThru
6581
passthru
6682

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementProductToGroup.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Adds a product to a group.
1414

1515
```
1616
Add-AzureRmApiManagementProductToGroup -Context <PsApiManagementContext> -GroupId <String> -ProductId <String>
17-
[-PassThru] [<CommonParameters>]
17+
[-PassThru] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -25,6 +25,7 @@ In other words, this cmdlet assigns a group to a product.
2525

2626
### Example 1: Add a product to a group
2727
```
28+
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
2829
PS C:\>Add-AzureRmApiManagementProductToGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789"
2930
```
3031

@@ -48,6 +49,21 @@ Accept pipeline input: True (ByPropertyName)
4849
Accept wildcard characters: False
4950
```
5051
52+
### -DefaultProfile
53+
The credentials, account, tenant, and subscription used for communication with azure.
54+
55+
```yaml
56+
Type: IAzureContextContainer
57+
Parameter Sets: (All)
58+
Aliases: AzureRmContext, AzureCredential
59+
60+
Required: False
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
5167
### -GroupId
5268
Specifies the group ID.
5369
This parameter is required.

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementRegion.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Adds new deployment regions to a PsApiManagement instance.
1414

1515
```
1616
Add-AzureRmApiManagementRegion -ApiManagement <PsApiManagement> -Location <String> [-Sku <PsApiManagementSku>]
17-
[-Capacity <Int32>] [-VirtualNetwork <PsApiManagementVirtualNetwork>] [<CommonParameters>]
17+
[-Capacity <Int32>] [-VirtualNetwork <PsApiManagementVirtualNetwork>]
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -70,6 +71,21 @@ Accept pipeline input: False
7071
Accept wildcard characters: False
7172
```
7273
74+
### -DefaultProfile
75+
The credentials, account, tenant, and subscription used for communication with azure.
76+
77+
```yaml
78+
Type: IAzureContextContainer
79+
Parameter Sets: (All)
80+
Aliases: AzureRmContext, AzureCredential
81+
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
7389
### -Location
7490
Specifies the location of the new deployment region.
7591
@@ -145,7 +161,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
145161
## INPUTS
146162
147163
### PsApiManagement
148-
149164
Parameter 'ApiManagement' accepts value of type 'PsApiManagement' from the pipeline
150165
151166
## OUTPUTS

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Add-AzureRmApiManagementUserToGroup.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Adds a user to a group.
1414

1515
```
1616
Add-AzureRmApiManagementUserToGroup -Context <PsApiManagementContext> -GroupId <String> -UserId <String>
17-
[-PassThru] [<CommonParameters>]
17+
[-PassThru] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -24,6 +24,7 @@ The **Add-AzureRmApiManagementUserToGroup** cmdlet adds a user to a group.
2424

2525
### Example 1: Add a user to a group
2626
```
27+
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
2728
PS C:\>Add-AzureRmApiManagementUserToGroup -Context $apimContext -GroupId "0001" -UserId "0123456789"
2829
```
2930

@@ -47,6 +48,21 @@ Accept pipeline input: True (ByPropertyName)
4748
Accept wildcard characters: False
4849
```
4950
51+
### -DefaultProfile
52+
The credentials, account, tenant, and subscription used for communication with azure.
53+
54+
```yaml
55+
Type: IAzureContextContainer
56+
Parameter Sets: (All)
57+
Aliases: AzureRmContext, AzureCredential
58+
59+
Required: False
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
5066
### -GroupId
5167
Specifies the group ID.
5268
This parameter is required.

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/AzureRM.ApiManagement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Creates a new Backend Credential contract.
114114
Creates a new Backend Proxy Object.
115115

116116
### [New-AzureRmApiManagementCertificate](New-AzureRmApiManagementCertificate.md)
117-
Creates an API Management certificate.
117+
Creates an API Management certificate to be used during Authentication with Backend.
118118

119119
### [New-AzureRmApiManagementContext](New-AzureRmApiManagementContext.md)
120120
Creates an instance of PsAzureApiManagementContext.

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Backup-AzureRmApiManagement.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ Backs up an API Management service.
1313
## SYNTAX
1414

1515
```
16-
Backup-AzureRmApiManagement -ResourceGroupName <String> -Name <String> -StorageContext <AzureStorageContext>
17-
-TargetContainerName <String> [-TargetBlobName <String>] [-PassThru] [<CommonParameters>]
16+
Backup-AzureRmApiManagement -ResourceGroupName <String> -Name <String> -StorageContext <IStorageContext>
17+
-TargetContainerName <String> [-TargetBlobName <String>] [-PassThru]
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -32,6 +33,21 @@ This command backs up an API Management service to a Storage blob.
3233

3334
## PARAMETERS
3435

36+
### -DefaultProfile
37+
The credentials, account, tenant, and subscription used for communication with azure.
38+
39+
```yaml
40+
Type: IAzureContextContainer
41+
Parameter Sets: (All)
42+
Aliases: AzureRmContext, AzureCredential
43+
44+
Required: False
45+
Position: Named
46+
Default value: None
47+
Accept pipeline input: False
48+
Accept wildcard characters: False
49+
```
50+
3551
### -Name
3652
Specifies the name of the API Management deployment that this cmdlet backs up.
3753
@@ -81,7 +97,7 @@ Accept wildcard characters: False
8197
Specifies a storage connection context.
8298
8399
```yaml
84-
Type: AzureStorageContext
100+
Type: IStorageContext
85101
Parameter Sets: (All)
86102
Aliases:
87103

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Export-AzureRmApiManagementApi.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,15 @@ Exports an API to a file.
1515
### Export to pipeline (Default)
1616
```
1717
Export-AzureRmApiManagementApi -Context <PsApiManagementContext> -ApiId <String>
18-
-SpecificationFormat <PsApiManagementApiFormat> [-WhatIf] [-Confirm] [<CommonParameters>]
18+
-SpecificationFormat <PsApiManagementApiFormat> [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
19+
[-Confirm] [<CommonParameters>]
1920
```
2021

2122
### Export to File
2223
```
2324
Export-AzureRmApiManagementApi -Context <PsApiManagementContext> -ApiId <String>
24-
-SpecificationFormat <PsApiManagementApiFormat> -SaveAs <String> [-Force] [-PassThru] [-WhatIf] [-Confirm]
25-
[<CommonParameters>]
25+
-SpecificationFormat <PsApiManagementApiFormat> -SaveAs <String> [-Force] [-PassThru]
26+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2627
```
2728

2829
## DESCRIPTION
@@ -32,6 +33,7 @@ The **Export-AzureRmApiManagementApi** cmdlet exports an Azure API Management AP
3233

3334
### Example 1: Export an API in Web Application Description Language (WADL) format
3435
```
36+
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
3537
PS C:\>Export-AzureRmApiManagementApi -Context $ApiMgmtContext -ApiId "0123456789" -SpecificationFormat "Wadl" -SaveAs "C:\contoso\specifications\0123456789.wadl"
3638
```
3739

@@ -69,6 +71,21 @@ Accept pipeline input: True (ByPropertyName)
6971
Accept wildcard characters: False
7072
```
7173
74+
### -DefaultProfile
75+
The credentials, account, tenant, and subscription used for communication with azure.
76+
77+
```yaml
78+
Type: IAzureContextContainer
79+
Parameter Sets: (All)
80+
Aliases: AzureRmContext, AzureCredential
81+
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
7289
### -Force
7390
Indicates that this operation overwrites the file of the same name if it already exists.
7491

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagement.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,19 @@ Gets a list or a particular API Management Service description.
1414

1515
### All In Subscription (Default)
1616
```
17-
Get-AzureRmApiManagement [<CommonParameters>]
17+
Get-AzureRmApiManagement [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1818
```
1919

2020
### All In Resource Group
2121
```
22-
Get-AzureRmApiManagement -ResourceGroupName <String> [<CommonParameters>]
22+
Get-AzureRmApiManagement -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>]
23+
[<CommonParameters>]
2324
```
2425

2526
### Specific API Management Service
2627
```
27-
Get-AzureRmApiManagement -ResourceGroupName <String> -Name <String> [<CommonParameters>]
28+
Get-AzureRmApiManagement -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>]
29+
[<CommonParameters>]
2830
```
2931

3032
## DESCRIPTION
@@ -48,6 +50,21 @@ This command gets all API Management service by name.
4850

4951
## PARAMETERS
5052

53+
### -DefaultProfile
54+
The credentials, account, tenant, and subscription used for communication with azure.
55+
56+
```yaml
57+
Type: IAzureContextContainer
58+
Parameter Sets: (All)
59+
Aliases: AzureRmContext, AzureCredential
60+
61+
Required: False
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
5168
### -Name
5269
Specifies the name of API Management service.
5370

0 commit comments

Comments
 (0)