Add-VSTeamServiceFabricEndpoint
SYNOPSIS
Adds a new Service Fabric service endpoint.
SYNTAX
Certificate (Default)
Add-VSTeamServiceFabricEndpoint [-endpointName] <String> [-url] <String> -certificate <String>
-certificatePassword <SecureString> -serverCertThumbprint <String> -ProjectName <String> [<CommonParameters>]
AzureAd
Add-VSTeamServiceFabricEndpoint [-endpointName] <String> [-url] <String> -serverCertThumbprint <String>
-username <String> -password <SecureString> -ProjectName <String> [<CommonParameters>]
None
Add-VSTeamServiceFabricEndpoint [-endpointName] <String> [-url] <String> [-clusterSpn <String>]
[[-useWindowsSecurity] <Boolean>] -ProjectName <String> [<CommonParameters>]
DESCRIPTION
The cmdlet adds a new Service Fabric service endpoint to an existing project.
EXAMPLES
Example 1
Add-VSTeamServiceFabricEndpoint -ProjectName "SomeProjectName" -endpointName "NoAuthTest" -url "tcp://10.0.0.1:19000" -useWindowsSecurity $false
Adds a Service Fabric Endpoint for a non-secure cluster
Example 2
$password = '00000000-0000-0000-0000-000000000000' | ConvertTo-SecureString -AsPlainText -Force
Add-VSTeamServiceFabricEndpoint -ProjectName "SomeProjectName" -endpointName "AzureAdAuthTest" -url "tcp://10.0.0.1:19000" -serverCertThumbprint "SOMECERTTHUMBPRINT" -username "someUser@someplace.com" -password $password
Adds a Service Fabric Endpoint for an Azure AD secured cluster.
Example 3
$password = '00000000-0000-0000-0000-000000000000' | ConvertTo-SecureString -AsPlainText -Force
$pathToPFX = "C:\someFolder\theCertificateFile.pfx"
$base64Cert = [System.Convert]::ToBase64String([System.IO.File]::ReadAllBytes($pathToPFX))
Add-VSTeamServiceFabricEndpoint -ProjectName "SomeProjectName" -endpointName "CertificateAuthTest" -url "tcp://10.0.0.1:19000" -serverCertThumbprint "SOMECERTTHUMBPRINT" -certificate $base64Cert -certificatePassword $password
Adds a Service Fabric Endpoint for a certificate secured cluster.
PARAMETERS
-url
The url of the Service Fabric management endpoint.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-useWindowsSecurity
If windows integrated authentication should be enabled. If set to false, all authentication is disabled.
Type: Boolean
Parameter Sets: None
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-clusterSpn
Specify the cluster service principal name, for use with windows integrated authentication.
Type: String
Parameter Sets: None
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-serverCertThumbprint
The server certificate thumbprint, used for communicating with the Service Fabric cluster.
Type: String
Parameter Sets: Certificate, AzureAd
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-username
The Azure AD Username, used for communicating with the Service Fabric cluster.
Type: String
Parameter Sets: AzureAd
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-password
The Password for the Azure AD User, used for communicating with the Service Fabric cluster.
Type: SecureString
Parameter Sets: AzureAd
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-certificate
The certificate used for communicating with the Service Fabric cluster.
Type: String
Parameter Sets: Certificate
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-certificatePassword
The Password for the certificate used for communicating with the Service Fabric cluster.
Type: SecureString
Parameter Sets: Certificate
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-endpointName
The name displayed on the services page. In AzD this is the Connection Name.
Type: String
Parameter Sets: (All)
Aliases: displayName
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ProjectName
Specifies the team project for which this function operates.
You can tab complete from a list of available projects.
You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
vsteam_lib.ServiceEndpoint
NOTES
Prerequisites:
Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.
tips:
- check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
- use Set-VSTeamDefaultProject to set default project for every call
- use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
- use Profiles to load an account and the correct version