你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Set-AzBlueprintArtifact
Update an artifact in a blueprint definition.
Syntax
Set-AzBlueprintArtifact
-Name <String>
-Type <PSArtifactKind>
-Blueprint <PSBlueprintBase>
[-Description <String>]
[-DependsOn <System.Collections.Generic.List`1[System.String]>]
-TemplateParameterFile <String>
-TemplateFile <String>
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzBlueprintArtifact
-Name <String>
-Blueprint <PSBlueprintBase>
-ArtifactFile <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzBlueprintArtifact
-Name <String>
-Type <PSArtifactKind>
-Blueprint <PSBlueprintBase>
[-Description <String>]
[-DependsOn <System.Collections.Generic.List`1[System.String]>]
-RoleDefinitionId <String>
-RoleDefinitionPrincipalId <String[]>
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzBlueprintArtifact
-Name <String>
-Type <PSArtifactKind>
-Blueprint <PSBlueprintBase>
[-Description <String>]
[-DependsOn <System.Collections.Generic.List`1[System.String]>]
-PolicyDefinitionId <String>
-PolicyDefinitionParameter <Hashtable>
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
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. 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.
Examples
Example 1
$bp = Get-AzBlueprint -Name SimpleBlueprint
Set-AzBlueprintArtifact -Name PolicyStorage -Blueprint $bp -ArtifactFile C:\PolicyAssignmentStorageTag.json
DisplayName :
Description : Apply storage tag and the parameter also used by the template to resource groups
DependsOn :
PolicyDefinitionId : /providers/Microsoft.Authorization/policyDefinitions/49c88fc8-6fd1-46fd-a676-f12d1d3a4c71
Parameters : {[tagName, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue], [tagValue, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue]}
ResourceGroup :
Id : /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprints/AppNetwork/artifacts/PolicyAssignmentStorageTag
Type : Microsoft.Blueprint/blueprints/artifacts
Name : PolicyAssignmentStorageTag
Update an artifact through an artifact JSON file.
Example 2
$bp = Get-AzBlueprint -Name SimpleBlueprint
Set-AzBlueprintArtifact -Type PolicyAssignmentArtifact -Name "ApplyTag-RG" -Blueprint $bp -PolicyDefinitionId "/providers/Microsoft.Authorization/policyDefinitions/49c88fc8-6fd1-46fd-a676-f12d1d3a4c71" -PolicyDefinitionParameter @{tagName="[parameters('tagName')]"; tagValue="[parameters('tagValue')]"} -ResourceGroupName storageRG
DisplayName : ApplyTag-RG
Description :
DependsOn :
PolicyDefinitionId : /providers/Microsoft.Authorization/policyDefinitions/49c88fc8-6fd1-46fd-a676-f12d1d3a4c71
Parameters : {[tagValue, Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue], [tagName,
Microsoft.Azure.Commands.Blueprint.Models.PSParameterValue]}
ResourceGroup : storageRG
Id : /subscriptions/28cbf98f-381d-4425-9ac4-cf342dab9753/providers/Microsoft.Blueprint/blueprints/AppNetwork/
artifacts/ApplyTag-RG
Type : Microsoft.Blueprint/blueprints/artifacts
Name : ApplyTag-RG
Update an artifact through inline parameters.
Example 3
$bp = Get-AzBlueprint -Name SimpleBlueprint
Set-AzBlueprintArtifact -Type TemplateArtifact -Name storage-account -Blueprint $bp -TemplateFile C:\StorageAccountArmTemplate.json -ResourceGroupName "storageRG" -TemplateParameterFile C:\Workspace\BlueprintTemplates\RestTemplatesSomeInline\StorageAccountParameters.json
DisplayName : storage-account
Description :
DependsOn :
Template : {$schema, contentVersion, parameters, variables...}
Parameters : {}
ResourceGroup : storageRG
Id : /subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprints/AppNetwork/artifacts/storage-account
Type : Microsoft.Blueprint/blueprints/artifacts
Name : storage-account
Update an artifact through an ARM template file.
Parameters
-ArtifactFile
Location of the artifact file in JSON format on disk.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Blueprint
Blueprint object.
Type: | PSBlueprintBase |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DependsOn
List of the names of artifacts that needs to be created before current artifact is created.
Type: | List<T>[String] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Description
Description of the artifact.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Name of the artifact
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PolicyDefinitionId
Definition Id of the policy definition.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PolicyDefinitionParameter
Hashtable of parameters to pass to the policy definition artifact.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
Name of the resource group the artifact is going to be under.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RoleDefinitionId
List of role definition
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RoleDefinitionPrincipalId
List of role definition principal ids.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TemplateFile
Location of the ARM template file on disk.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TemplateParameterFile
Location of the ARM template parameter file on disk.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Type
Type of the artifact. There are 3 types supported: RoleAssignmentArtifact, PolicyAssignmentArtifact, TemplateArtifact.
Type: | PSArtifactKind |
Accepted values: | RoleAssignmentArtifact, PolicyAssignmentArtifact, TemplateArtifact |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
List<T>[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
String[]