Skip to content

Commit 11134e8

Browse files
ikanniikanni
authored andcommitted
Fixed comment
2 parents f247415 + a36c72f commit 11134e8

File tree

328 files changed

+59501
-16742
lines changed

Some content is hidden

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

328 files changed

+59501
-16742
lines changed

src/ApiManagement/ApiManagement/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
-->
2020
## Upcoming Release
2121
* Update `-Format` parameter description in `Set-AzApiManagementPolicy` reference documentation
22+
* Removed references of deprecated cmdlet `Update-AzApiManagementDeployment` from reference documentation. Use `Set-AzApiManagement` instead.
2223

2324
## Version 1.3.0
2425
* Fixed miscellaneous typos across module

src/ApiManagement/ApiManagement/help/Add-AzApiManagementRegion.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Add-AzApiManagementRegion -ApiManagement <PsApiManagement> -Location <String> [-
2222
## DESCRIPTION
2323
The **Add-AzApiManagementRegion** cmdlet adds new instance of type **PsApiManagementRegion** to the collection of **AdditionalRegions** of provided instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**.
2424
This cmdlet does not deploy anything by itself but updates instance of **PsApiManagement** in-memory.
25-
To update a deployment of an API Management pass the modified **PsApiManagement** Instance to Update-AzApiManagementDeployment.
25+
To update a deployment of an API Management pass the modified **PsApiManagement** Instance to Set-AzApiManagement.
2626

2727
## EXAMPLES
2828

@@ -34,8 +34,10 @@ PS C:\>Add-AzApiManagementRegion -ApiManagement $ApiManagement -Location "East U
3434
This command adds two premium SKU units and the region named East US to the **PsApiManagement** instance.
3535

3636
### Example 2: Add new deployment regions to a PsApiManagement instance and then update deployment
37-
```
38-
PS C:\>Get-AzApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi" | Add-AzApiManagementRegion -Location "East US" -Sku "Premium" -Capacity 2 | Update-AzApiManagementDeployment
37+
```powershell
38+
PS C:\>$service = Get-AzApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi"
39+
PS C:\>$service = Add-AzApiManagementRegion -ApiManagement $service -Location $secondarylocation -VirtualNetwork $additionalRegionVirtualNetwork
40+
PS C:\>$service = Set-AzApiManagement -InputObject $service -PassThru
3941
```
4042

4143
This command gets a **PsApiManagement** object, adds two premium SKU units for the region named East US, and then updates deployment.
@@ -159,6 +161,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
159161
160162
[Update-AzApiManagementRegion](./Update-AzApiManagementRegion.md)
161163
162-
[Update-AzApiManagementDeployment](./Update-AzApiManagementDeployment.md)
164+
[Set-AzApiManagement](./Set-AzApiManagement.md)
163165
164166

src/ApiManagement/ApiManagement/help/New-AzApiManagementVirtualNetwork.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,28 @@ New-AzApiManagementVirtualNetwork -SubnetResourceId <String> [-DefaultProfile <I
2020

2121
## DESCRIPTION
2222
The **New-AzApiManagementVirtualNetwork** cmdlet is a helper command to create an instance of **PsApiManagementVirtualNetwork**.
23-
This command is used with **Update-AzApiManagementDeployment** cmdlet.
23+
This command is used with **Set-AzApiManagement** and **New-AzApiManagement** cmdlet.
2424

2525
## EXAMPLES
2626

27-
### Example 1: Create a virtual network
27+
### Example 1: Create a virtual network and Update an existing APIM service into the VNET
28+
```powershell
29+
PS C:\> $virtualNetwork = New-AzApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-WestUS/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
30+
PS C:\> $apim = Get-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi"
31+
PS C:\> $apim.VpnType = "External"
32+
PS C:\> $apim.VirtualNetwork = $virtualNetwork
33+
PS C:\> Set-AzApiManagement -InputObject $apim
2834
```
29-
PS C:\>$vnetName = "myvnet"
30-
PS C:\>$subnetName = "default"
31-
PS C:\>$subnet = New-AzVirtualNetworkSubnetConfig -Name $subnetName -AddressPrefix 10.0.1.0/24
32-
PS C:\>$vnet = New-AzVirtualNetwork -Name $vnetName -ResourceGroupName $resourceGroupName -Location $location -AddressPrefix 10.0.0.0/16 -Subnet $subnet
3335

34-
# Create a Virtual Network Object
35-
PS C:\>$virtualNetwork = New-AzApiManagementVirtualNetwork -Location $location -SubnetResourceId $vnet.Subnets[0].Id
36+
This example creates a virtual network and then calls the **Set-AzApiManagement** cmdlet.
3637

37-
# Get the service
38-
PS C:\>$service = Get-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName
39-
PS C:\>$service.VirtualNetwork = $virtualNetwork
40-
PS C:\>$service.VpnType = "External"
41-
42-
# Update the Deployment with Virtual Network
43-
PS C:\>Update-AzApiManagementDeployment -ApiManagement $service
38+
### Example 2: Create an API Management service for an external virtual network
39+
```powershell
40+
PS C:\> $virtualNetwork = New-AzApiManagementVirtualNetwork -Location "West US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet"
41+
PS C:\> New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium"
4442
```
4543

46-
This example creates a virtual network and then calls the **Update-AzApiManagementDeployment** cmdlet.
44+
This example creates a new APIM service into a Virtual Network in `External` mode
4745

4846
## PARAMETERS
4947

@@ -92,5 +90,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9290
9391
## RELATED LINKS
9492
95-
[Update-AzApiManagementDeployment](./Update-AzApiManagementDeployment.md)
93+
[Set-AzApiManagement](./Set-AzApiManagement.md)
94+
[New-AzApiManagement](./New-AzApiManagement.md)
9695

src/ApiManagement/ApiManagement/help/Remove-AzApiManagementRegion.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Remove-AzApiManagementRegion -ApiManagement <PsApiManagement> -Location <String>
2121
## DESCRIPTION
2222
The **Remove-AzApiManagementRegion** cmdlet removes instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion** from a collection of **AdditionalRegions** of provided the instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**.
2323
This cmdlet does not modify deployment by itself but updates the instance of **PsApiManagement** in-memory.
24-
To update a deployment of an API Management, pass the modified **PsApiManagementInstance** to **Update-AzApiManagement**.
24+
To update a deployment of an API Management, pass the modified **PsApiManagementInstance** to **Set-AzApiManagement**.
2525

2626
## EXAMPLES
2727

@@ -34,7 +34,7 @@ This command removes the region named East US from the **PsApiManagement** insta
3434

3535
### Example 2: Remove a region from a PsApiManagement instance using a series of commands
3636
```
37-
PS C:\>Get-AzApiManagement -ResourceGroupName "Contoso" -Name ContosoApi | Remove-AzApiManagementRegion -Location "East US" | Update-AzApiManagementDeployment
37+
PS C:\>Get-AzApiManagement -ResourceGroupName "Contoso" -Name ContosoApi | Remove-AzApiManagementRegion -Location "East US" | Set-AzApiManagement
3838
```
3939

4040
This first command gets an instance of **PsApiManagement** from the resource group named Contoso named ContosoApi.

src/ApiManagement/ApiManagement/help/Update-AzApiManagementRegion.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,18 @@ Update-AzApiManagementRegion -ApiManagement <PsApiManagement> -Location <String>
2222
## DESCRIPTION
2323
The **Update-AzApiManagementRegion** cmdlet updates an existing instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion** in a collection of **AdditionalRegions** objects of a provided instance of type **Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement**.
2424
This cmdlet does not deploy anything but updates an instance of **PsApiManagement** in-memory.
25-
To update a deployment of an API Management use the modified **PsApiManagementInstance** to the Update-AzApiManagementDeployment cmdlet.
25+
To update a deployment of an API Management use the modified **PsApiManagementInstance** to the Set-AzApiManagement cmdlet.
2626

2727
## EXAMPLES
2828

2929
### Example 1: Increases capacity of Additional Region in a PsApiManagement instance
3030
```powershell
3131
PS C:\>$apimService = Get-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName
3232
PS C:\>$apimService = Update-AzApiManagementRegion -ApiManagement $apimService -Location "North Central US" -Capacity 2 -Sku Premium
33-
34-
# Set the ApiManagement service and Enable Msi idenity on the service
35-
PS C:\>$updatedService = Set-AzApiManagement -InputObject $apimService -PassThru
33+
PS C:\>$apimService = Set-AzApiManagement -InputObject $apimService -PassThru
3634
```
3735

38-
This command gets the API Management Premium SKU service, having regions in South Central US and North Central US. It then increases the Capacity of the North Central US region to 2 using the **Update-AzApiManagementRegion**. The next cmdlet Set-AzApiManagement applies the configuration change to the Api Management service.
36+
This command gets the API Management Premium SKU service, having regions in South Central US and North Central US. It then increases the Capacity of the North Central US region to 2 using the **Set-AzApiManagement**. The next cmdlet **Set-AzApiManagement** applies the configuration change to the Api Management service.
3937

4038
## PARAMETERS
4139

@@ -165,4 +163,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
165163
166164
[Remove-AzApiManagementRegion](./Remove-AzApiManagementRegion.md)
167165
168-
[Update-AzApiManagementDeployment](./Update-AzApiManagementDeployment.md)
166+
[Set-AzApiManagement](./Set-AzApiManagement.md)

src/Automation/Automation.Test/ScenarioTests/AutomationTests.cs

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,9 @@ public void TestAutomationStartUnpublishedRunbook()
7272
TestRunner.RunTestScript("Test-AutomationStartUnpublishedRunbook -runbookPath ScenarioTests\\Resources\\Test-WorkFlowWithVariousParameters.ps1");
7373
}
7474

75-
// Playback error:
76-
/* Message: System.Management.Automation.ActionPreferenceStopException :
77-
* The running command stopped because the preference variable "ErrorActionPreference" or common parameter
78-
* is set to Stop: Unable to find a matching HTTP request for URL
79-
* 'PUT /subscriptions/d2b38167-d3ca-4d1f-a020-948eee21b6bc/resourceGroups/to-delete-01/providers/Microsoft.Automation/automationAccounts/fbs-aa-01/jobs/bf922f22-eafa-4208-a6c7-55b5431a9da4?api-version=2017-05-15-preview'.
80-
* Calling method Item().
81-
*/
82-
[Fact(Skip = "Test does not work on playback mode due to a guid being created.")]
83-
[Trait(Category.Service, Category.Automation)]
75+
[Fact(Skip = "Need x64 test framework.")]
8476
[Trait(Category.AcceptanceType, Category.CheckIn)]
85-
[Trait(Category.AcceptanceType, Category.BVT)]
77+
[Trait(Category.Service, Category.Automation)]
8678
public void TestAutomationRunbookWithParameter()
8779
{
8880
TestRunner.RunTestScript("Test-RunbookWithParameter -runbookPath ScenarioTests\\Resources\\Test-PowershellRunbook.ps1 -type 'PowerShell' -parameters @{'nums'=@(1,2,3,4,5,6,7)} -expectedResult 28");
@@ -95,21 +87,5 @@ public void TestAutomationPy2RunbookWithParameter()
9587
{
9688
TestRunner.RunTestScript("Test-RunbookWithParameter -runbookPath ScenarioTests\\Resources\\TestPythonRunbook.py -type 'Python2' -parameters @{'param1'='1';'param2'='2';'param3'='3';'param4'='4';'param5'='5';'param6'='6';'param7'='7'} -expectedResult 28");
9789
}
98-
99-
// Playback error:
100-
/* Message: System.Management.Automation.ActionPreferenceStopException :
101-
* The running command stopped because the preference variable "ErrorActionPreference" or common parameter
102-
* is set to Stop: Unable to find a matching HTTP request for URL
103-
* 'PUT /subscriptions/d2b38167-d3ca-4d1f-a020-948eee21b6bc/resourceGroups/to-delete-01/providers/Microsoft.Automation/automationAccounts/fbs-aa-01/jobs/c326d98d-8f3c-462d-9dc4-7669dfd3fcdb?api-version=2017-05-15-preview'.
104-
* Calling method Item().
105-
*/
106-
[Fact(Skip = "Test does not work on playback mode due to a guid being created.")]
107-
[Trait(Category.Service, Category.Automation)]
108-
[Trait(Category.AcceptanceType, Category.CheckIn)]
109-
[Trait(Category.AcceptanceType, Category.BVT)]
110-
public void TestAutomationRunbookWithParameterAndWait()
111-
{
112-
TestRunner.RunTestScript("Test-RunbookWithParameterAndWait -runbookPath ScenarioTests\\Resources\\Test-PowershellRunbook.ps1 -type 'PowerShell' -parameters @{'nums'=@(1,2,3,4,5,6,7)} -expectedResult 28");
113-
}
11490
}
11591
}

src/Automation/Automation/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
-->
2020
## Upcoming Release
2121
* Fixed example typo in reference documentation for `Register-AzAutomationDscNode`
22+
* Added clarification on OS restriction to Register-AzAutomationDSCNode
2223
* Fixed Start-AzAutomationRunbook cmdlet Null reference exception for -Wait option.
2324

2425
## Version 1.3.2

src/Automation/Automation/help/Register-AzAutomationDscNode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ schema: 2.0.0
99
# Register-AzAutomationDscNode
1010

1111
## SYNOPSIS
12-
Registers an Azure virtual machine as a DSC node for an Automation account.
12+
Registers an Azure virtual machine running Windows OS as a DSC node for an Automation account.
1313

1414
## SYNTAX
1515

@@ -22,7 +22,7 @@ Register-AzAutomationDscNode -AzureVMName <String> [-NodeConfigurationName <Stri
2222
```
2323

2424
## DESCRIPTION
25-
The **Register-AzAutomationDscNode** cmdlet registers an Azure virtual machine as an APS Desired State Configuration (DSC) node in an Azure Automation account.
25+
The **Register-AzAutomationDscNode** cmdlet registers an Azure virtual machine as an APS Desired State Configuration (DSC) node in an Azure Automation account. This cmdlet will only register VMs running Windows OS as an Automation DSC Node for an account.
2626

2727
If you need to register a node to an automation account in a different subscription,
2828
you will need to use an ARM template rather than cmdlets.

src/Blueprint/Blueprint/Az.Blueprint.psd1

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: Microsoft Corporation
55
#
6-
# Generated on: 8/9/2019
6+
# Generated on: 9/6/2019
77
#
88

99
@{
@@ -12,7 +12,7 @@
1212
# RootModule = ''
1313

1414
# Version number of this module.
15-
ModuleVersion = '0.2.4'
15+
ModuleVersion = '0.2.5'
1616

1717
# Supported PSEditions
1818
CompatiblePSEditions = 'Core', 'Desktop'
@@ -114,8 +114,7 @@ PrivateData = @{
114114
# IconUri = ''
115115

116116
# ReleaseNotes of this module
117-
ReleaseNotes = '* Fixed miscellaneous typos across module
118-
* Bug fix (Get-AzBlueprint should work on national clouds)'
117+
ReleaseNotes = '* Add functionality to make sure Blueprint RP is registered before any service calls'
119118

120119
# Prerelease string of this module
121120
# Prerelease = ''

src/Blueprint/Blueprint/ChangeLog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
- Additional information about change #1
1919
-->
2020
## Upcoming Release
21+
22+
## Version 0.2.5
2123
* Add functionality to make sure Blueprint RP is registered before any service calls
2224

2325
## Version 0.2.4

0 commit comments

Comments
 (0)