New-AzureRmApiManagementProperty

Reference

Module:: AzureRM.ApiManagement

Creates a new Property.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureRmApiManagementProperty
   -Context <PsApiManagementContext>
   [-PropertyId <String>]
   -Name <String>
   -Value <String>
   [-Secret]
   [-Tag <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzureRmApiManagementProperty cmdlet creates an Azure API Management Property.

Examples

Example 1: Create a property that includes tags

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>$Tags = 'sdk', 'powershell'
PS C:\> New-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property11" -Name "Property Name" -Value "Property Value" -Tags $Tags

The first command assigns two values to the $Tags variable. The second command creates a property and assigns the strings in $Tags as tags on the property.

Example 2: Create a property that has a secret value

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>New-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property12" -Name "Secret Property -Value "Secret Property Value" -Secret

This command creates a Property that has a value that is encrypted.

Parameters

-Context

Specifies a PsApiManagementContext object.

Type:	PsApiManagementContext
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PropertyId

Specifies an ID for the property. Maximum length is 256 characters. If you do not specify an ID, this cmdlet generates one.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Secret

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

Tags to be associated with Property. This parameter is optional.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
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.