Set-​Azure​Rm​Api​Management​Property

Modifies an API Management Property.

Syntax

Set-AzureRmApiManagementProperty
   -Context <PsApiManagementContext>
   [-Name <String>]
   [-PassThru]
   -PropertyId <String>
   [-Secret <Boolean>]
   [-Tags <String[]>]
   [-Value <String>]
   [<CommonParameters>]

Description

The Set-AzureRmApiManagementProperty cmdlet modifies an Azure API Management Property.

Examples

Example 1: Change the tags on a property

PS C:\>$Tags = 'sdk', 'powershell'
PS C:\> Set-AzureRmApiManagementProperty -Context $ApimContext -PropertyId "Property11" -Tags $Tags -PassThru

The first command assigns two values to the $Tags variable.

The second command modifies the property that has the ID Property11. The command assigns the strings in $Tags as tags on the property.

Example 2: Modify a property to have a secret value

PS C:\>Set-AzureRmApiManagementProperty -Context $ApimContext -PropertyId "Property12" -Secret $True -PassThru

This command changes the property to be Encrypted.

Required Parameters

-Context

Specifies a PsApiManagementContext object.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PropertyId

Specifies an ID of the property that this cmdlet modifies.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Name

Specifies the name of the property. Maximum length is 100 characters. Names contain only letters, digits, period, dash, and underscore characters.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PassThru

Indicates that this cmdlet returns the PsApiManagementProperty that this cmdlet modifies.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Secret

Indicates that the property value is a secret and should be encrypted.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Tags

Specifies an array of tags that this cmdlet associates to the property. You can use tags to filter the property list.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Value

Specifies a value for the property. This value can contain policy expressions. Maximum length is 1000 characters. The value may not be empty or consist only of whitespace.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty