Edit

Share via

New-AzApiManagementSslSetting

Module:
Az.ApiManagement Module

Creates an instance of PsApiManagementSslSetting

Syntax

Default (Default) 

New-AzApiManagementSslSetting
    [-FrontendProtocol <Hashtable>]
    [-BackendProtocol <Hashtable>]
    [-CipherSuite <Hashtable>]
    [-ServerProtocol <Hashtable>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Helper command to create an instance of PsApiManagementSslSetting. This command is to be used with New-AzApiManagement command.

Examples

Example 1: Create an SSL Setting to enable TLS 1.0 on both Backend and Frontend

$enableTls=@{"Tls10" = "True"}
New-AzApiManagementSslSetting -FrontendProtocol $enableTls -BackendProtocol $enableTls

FrontendProtocols BackendProtocols CipherSuites ServerProtocols
----------------- ---------------- ------------ ---------------
{Tls10}           {Tls10}

Create an new instance of PsApiManagementSslSetting to Enable TLSv 1.0 in both Frontend (between client and APIM) and Backend (between APIM and Backend) of ApiManagement Gateway.

Parameters

-BackendProtocol

Backend Security protocol settings. This parameter is optional. The valid Protocol Settings are Tls11 - Tls 1.1 Tls10 - Tls 1.0 Ssl30 - SSL 3.0

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CipherSuite

Ssl cipher suites settings in the specified order. This parameter is optional. The valid Settings are TripleDes168 - Enable / Disable Tripe Des 168

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FrontendProtocol

Frontend Security protocols settings. This parameter is optional. The valid Protocol Settings are Tls11 - Tls 1.1 Tls10 - Tls 1.0 Ssl30 - SSL 3.0

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerProtocol

Server protocol settings like Http2. This parameter is optional. The valid Settings are Http2 - Enable Http 2.0

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSettings