Edit

Share via


New-AzApiManagementBackendServiceFabric

Creates an object of PsApiManagementServiceFabric

Syntax

Default (Default)

New-AzApiManagementBackendServiceFabric
    -ManagementEndpoint <String[]>
    [-ClientCertificateThumbprint <String>]
    [-ClientCertificateId <String>]
    [-MaxPartitionResolutionRetry <Int32>]
    [-ServerX509Name <Hashtable>]
    [-ServerCertificateThumbprint <String[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The New-AzApiManagementBackendServiceFabric cmdlet creates an object of PsApiManagementServiceFabric to be used in cmdlet New-AzApiManagementBackend and Set-AzApiManagementBackend.

Examples

Example 1: Create a Backend Service Fabric In-Memory Object

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$ManagementEndpoints = 'https://sfbackend-01.net:443', 'https://sfbackend-02.net:443'
$ServerCertificateThumbprints = '33CC47C6FCA848DC9B14A6F071C1EF7C'
$serviceFabric = New-AzApiManagementBackendServiceFabric -ManagementEndpoint  $ManagementEndpoints -ClientCertificateThumbprint "33CC47C6FCA848DC9B14A6F071C1EF7C" -ServerX509Name @{"CN=foobar.net" = @('33CC47C6FCA848DC9B14A6F071C1EF7C'); } -ServerCertificateThumbprint $ServerCertificateThumbprints

$backend = New-AzApiManagementBackend -Context  $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -ServiceFabricCluster $serviceFabric -Description "service fabric backend"

Creates a Backend Service Fabric Contract

Parameters

-ClientCertificateId

Client Certificate Id for the management endpoint. This parameter is optional.

Parameter properties

Type:String
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:True
Value from remaining arguments:False

-ClientCertificateThumbprint

Client Certificate Thumbprint for the management endpoint. This parameter is required.

Parameter properties

Type:String
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:True
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

-ManagementEndpoint

Service Fabric Cluster management Endpoints. This parameter is required.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-MaxPartitionResolutionRetry

Maximum number of retries when resolving a Service Fabric partition. This parameter is optional and default value is 5.

Parameter properties

Type:

Nullable<T>[Int32]

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

-ServerCertificateThumbprint

Thumbprint of certificates cluster management service uses for tls communication.This parameter is optional.

Parameter properties

Type:

String[]

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

-ServerX509Name

Server X509 Certificate Names Collection. This parameter is optional.

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

String

Outputs

PsApiManagementServiceFabric