Skip to content

Commit 86fb7b4

Browse files
author
Filiz Topatan
committed
Incorporate review comments-4. Update the help files + add output type
1 parent 554f0b9 commit 86fb7b4

10 files changed

+33
-33
lines changed

src/Blueprint/Blueprint/Cmdlets/BlueprintDefinition/ImportAzureRMBlueprint.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
namespace Microsoft.Azure.Commands.Blueprint.Cmdlets
2121
{
22-
[Cmdlet("Import", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "BlueprintWithArtifact", SupportsShouldProcess = true, DefaultParameterSetName = ParameterSetNames.ImportBlueprintParameterSet)]
22+
[Cmdlet("Import", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "BlueprintWithArtifact", SupportsShouldProcess = true, DefaultParameterSetName = ParameterSetNames.ImportBlueprintParameterSet), OutputType(typeof(bool))]
2323
public class ImportAzureRmBlueprint : BlueprintDefinitionCmdletBase
2424
{
2525
#region Parameters

src/Blueprint/Blueprint/help/Az.Blueprint.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,40 +12,40 @@ The topics in this section document the Azure PowerShell cmdlets for Azure Bluep
1212

1313
## Az.Blueprint Cmdlets
1414
### [Export-AzBlueprintWithArtifact](Export-AzBlueprintWithArtifact.md)
15-
Export specified blueprint to the specified output location as a JSON file.
15+
Export specified blueprint definition to the specified output location as a JSON file.
1616

1717
### [Get-AzBlueprint](Get-AzBlueprint.md)
1818
Get one or more blueprint definitions.
1919

2020
### [Get-AzBlueprintArtifact](Get-AzBlueprintArtifact.md)
21-
Get artifact from a blueprint.
21+
Get artifact from a blueprint definition.
2222

2323
### [Get-AzBlueprintAssignment](Get-AzBlueprintAssignment.md)
2424
Get one or more blueprint assignments.
2525

2626
### [Import-AzBlueprintWithArtifact](Import-AzBlueprintWithArtifact.md)
27-
Import a blueprint file in JSON format to a blueprint object and save it within the specified subscription or management group.
27+
Import a blueprint definition file in JSON format and save it to a blueprint object within the specified subscription or management group.
2828

2929
### [New-AzBlueprint](New-AzBlueprint.md)
30-
Create a new blueprint and save it within the specified subscription or management group.
30+
Create a new blueprint definition and save it within the specified subscription or management group.
3131

3232
### [New-AzBlueprintArtifact](New-AzBlueprintArtifact.md)
33-
Create a new artifact and save it within a blueprint.
33+
Create a new artifact and save it within a blueprint definition.
3434

3535
### [New-AzBlueprintAssignment](New-AzBlueprintAssignment.md)
3636
Assign a blueprint definition to a subscription.
3737

3838
### [Publish-AzBlueprint](Publish-AzBlueprint.md)
39-
Publish a new version of a blueprint.
39+
Publish a new version of a blueprint definition.
4040

4141
### [Remove-AzBlueprintAssignment](Remove-AzBlueprintAssignment.md)
4242
Remove a blueprint assignment from a subscription.
4343

4444
### [Set-AzBlueprint](Set-AzBlueprint.md)
45-
Update a new blueprint and save it within the specified subscription or management group.
45+
Update a blueprint and save it within the specified subscription or management group.
4646

4747
### [Set-AzBlueprintArtifact](Set-AzBlueprintArtifact.md)
48-
Update an artifact in a blueprint.
48+
Update an artifact in a blueprint definition.
4949

5050
### [Set-AzBlueprintAssignment](Set-AzBlueprintAssignment.md)
5151
Update an existing blueprint assignment.

src/Blueprint/Blueprint/help/Export-AzBlueprintWithArtifact.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Export-AzBlueprintWithArtifact
99

1010
## SYNOPSIS
11-
Export specified blueprint to the specified output location as a JSON file.
11+
Export specified blueprint definition to the specified output location as a JSON file.
1212

1313
## SYNTAX
1414

@@ -18,7 +18,7 @@ Export-AzBlueprintWithArtifact -Blueprint <PSBlueprintBase> -OutputPath <String>
1818
```
1919

2020
## DESCRIPTION
21-
Export a blueprint with it's artifact and save to disk.
21+
Export a blueprint definition with its artifacts and save to disk.
2222

2323
## EXAMPLES
2424

@@ -28,12 +28,12 @@ PS C:\> $bp = Get-AzBlueprint -Name SimpleBlueprint
2828
PS C:\> Export-AzBlueprintWithArtifact -Blueprint $bp -Version 1.0 -OutputPath C:\Blueprints
2929
```
3030

31-
Export a blueprint with it's artifact and save to disk.
31+
Export a blueprint definition with its artifacts and save to disk.
3232

3333
## PARAMETERS
3434

3535
### -Blueprint
36-
The Blueprint definition object to export.
36+
The blueprint definition object to export.
3737

3838
```yaml
3939
Type: PSBlueprintBase

src/Blueprint/Blueprint/help/Get-AzBlueprintArtifact.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-AzBlueprintArtifact
99

1010
## SYNOPSIS
11-
Get artifact from a blueprint.
11+
Retrieve artifacts from a blueprint definition.
1212

1313
## SYNTAX
1414

@@ -18,7 +18,7 @@ Get-AzBlueprintArtifact [-Name <String>] -Blueprint <PSBlueprintBase> [-Blueprin
1818
```
1919

2020
## DESCRIPTION
21-
Retrieve a blueprint artifact with its properties.
21+
Retrieve artifacts from a blueprint definition. If a blueprint definition version is not specified, the draft version is retrieved. In the case where there is no draft version, the latest published blueprint definition is returned.
2222

2323
## EXAMPLES
2424

@@ -50,7 +50,7 @@ Name : 0e1593da-47d5-4b75-800c-9a797dd23192
5050
5151
```
5252

53-
Retrieve a blueprint artifact with its properties. If blueprint version is not specified, draft version is retrieved. In the case where there is no draft version, latest published blueprint returned.
53+
Retrieve artifacts from a blueprint definition..
5454

5555
## PARAMETERS
5656

src/Blueprint/Blueprint/help/Import-AzBlueprintWithArtifact.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Import-AzBlueprintWithArtifact -Name <String> [-SubscriptionId <String>] [-Manag
1818
```
1919

2020
## DESCRIPTION
21-
Import a blueprint with its artifacts.
21+
Import a blueprint definition with its artifacts.
2222

2323
## EXAMPLES
2424

@@ -27,7 +27,7 @@ Import a blueprint with its artifacts.
2727
PS C:\> Import-AzBlueprintWithArtifact -Name SimpleBlueprint -SubscriptionId 00000000-1111-0000-1111-000000000000 -InputPath C:\Blueprints
2828
```
2929

30-
Import a blueprint with its artifacts and save within a subscription.
30+
Import a blueprint definition with its artifacts and save within a subscription.
3131

3232
## PARAMETERS
3333

src/Blueprint/Blueprint/help/New-AzBlueprint.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzBlueprint
99

1010
## SYNOPSIS
11-
Create a new blueprint and save it within the specified subscription or management group.
11+
Create a new blueprint definition and save it within the specified subscription or management group.
1212

1313
## SYNTAX
1414

@@ -25,7 +25,7 @@ New-AzBlueprint -Name <String> -ManagementGroupId <String> -BlueprintFile <Strin
2525
```
2626

2727
## DESCRIPTION
28-
Create a new blueprint. There are two main ways to create a blueprint: either by providing a blueprint JSON file or providing
28+
Create a new blueprint definition.
2929

3030
## EXAMPLES
3131

@@ -44,7 +44,7 @@ Parameters : {enforcetaganditsvalue_tagName, enforcetaganditsvalue_tagVal
4444
ResourceGroups : {AppNetworkRG}
4545
```
4646

47-
Create a new blueprint within the specified subscription.
47+
Create a new blueprint definition within the specified subscription.
4848

4949
## PARAMETERS
5050

src/Blueprint/Blueprint/help/New-AzBlueprintArtifact.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ schema: 2.0.0
99
# New-AzBlueprintArtifact
1010

1111
## SYNOPSIS
12-
Create a new artifact and save it within a blueprint.
12+
Create a new artifact and save it within a blueprint definition.
1313

1414
## SYNTAX
1515

@@ -44,8 +44,8 @@ New-AzBlueprintArtifact -Name <String> -Type <PSArtifactKind> -Blueprint <PSBlue
4444
```
4545

4646
## DESCRIPTION
47-
Create a new template artifact. There are two ways to create an artifact: either through an artifact JSON as an input file or through providing inline parameters for the artifact.
48-
while former doesn't require type of the artifact to be provided latter method requires user to provide the type of the artifact through -Type parameter.
47+
Create a new artifact. There are two ways to create an artifact: either through an artifact JSON as an input file or through providing inline parameters for the artifact.
48+
While the JSON method doesn't require type of the artifact to be provided inline parameter method requires user to provide the type of the artifact through -Type parameter.
4949

5050
## EXAMPLES
5151

@@ -65,7 +65,7 @@ Type : Microsoft.Blueprint/blueprints/artifacts
6565
Name : PolicyAssignmentStorageTag
6666
```
6767

68-
Create a new template artifact through an artifact JSON file.
68+
Create a new artifact through an artifact JSON file.
6969

7070
### Example 2
7171
```powershell

src/Blueprint/Blueprint/help/Publish-AzBlueprint.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Publish-AzBlueprint -Version <String> -Blueprint <PSBlueprint> [-DefaultProfile
1818
```
1919

2020
## DESCRIPTION
21-
Publish a new version of a blueprint.
21+
Publish a new version of a blueprint definition.
2222

2323
## EXAMPLES
2424

@@ -36,7 +36,7 @@ TargetScope : Subscription
3636
Parameters : {[tagName, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue], [tagValue, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue]}
3737
ResourceGroups : {storageRG}
3838
```
39-
Publish a new version of a blueprint.
39+
Publish a new version of a blueprint definition.
4040

4141
## PARAMETERS
4242

src/Blueprint/Blueprint/help/Set-AzBlueprint.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Set-AzBlueprint
99

1010
## SYNOPSIS
11-
Update a blueprint.
11+
Update a blueprint definition.
1212

1313
## SYNTAX
1414

@@ -25,7 +25,7 @@ Set-AzBlueprint -Name <String> -ManagementGroupId <String> -BlueprintFile <Strin
2525
```
2626

2727
## DESCRIPTION
28-
Update a blueprint and save it within the specified subscription or management group.
28+
Update a blueprint definition and save it within the specified subscription or management group.
2929

3030
## EXAMPLES
3131

@@ -44,7 +44,7 @@ Parameters : {enforcetaganditsvalue_tagName, enforcetaganditsvalue_tagVal
4444
ResourceGroups : {AppNetworkRG}
4545
```
4646

47-
Update a blueprint with new parameters.
47+
Update a blueprint definition with new parameters.
4848

4949
## PARAMETERS
5050

src/Blueprint/Blueprint/help/Set-AzBlueprintArtifact.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Set-AzBlueprintArtifact
99

1010
## SYNOPSIS
11-
Update an artifact in a blueprint.
11+
Update an artifact in a blueprint definition.
1212

1313
## SYNTAX
1414

@@ -45,7 +45,7 @@ Set-AzBlueprintArtifact -Name <String> -Type <PSArtifactKind> -Blueprint <PSBlue
4545

4646
## DESCRIPTION
4747
Update an artifact. There are two ways to update an artifact: either through an artifact JSON as an input file or through providing inline parameters for the artifact.
48-
while former doesn't require type of the artifact to be provided latter method requires user to provide the type of the artifact through -Type parameter.
48+
While the JSON method doesn't require type of the artifact to be provided inline parameter method requires user to provide the type of the artifact through -Type parameter.
4949

5050
## EXAMPLES
5151

@@ -331,7 +331,7 @@ Accept wildcard characters: False
331331
332332
### -Type
333333
Type of the artifact.
334-
There are 3 tpes supported: RoleAssignmentArtifact, PolicyAssignmentArtifact, TemplateArtifact.
334+
There are 3 types supported: RoleAssignmentArtifact, PolicyAssignmentArtifact, TemplateArtifact.
335335
336336
```yaml
337337
Type: PSArtifactKind

0 commit comments

Comments
 (0)