編集

次の方法で共有

New-NetworkControllerLoadBalancerProbe

Module:
NetworkController Module

This cmdlet adds/updates the health probes associated with a load balancer.

Syntax

Default (Default) 

New-NetworkControllerLoadBalancerProbe
    [-LoadBalancerId] <String>
    [-ResourceId] <String>
    [-Properties] <LoadBalancerProbeProperties>
    [[-ResourceMetadata] <ResourceMetadata>]
    [[-Etag] <String>]
    [-Force]
    -ConnectionUri <Uri>
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    [-PassInnerException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

This cmdlet adds/updates the health probes associated with a load balancer. Health probes are used by the load balancer to determine the health state of the backend pool members.

Examples

Example 1

This example creates a new health probe named probe1 for a load balancer resource named lb1. This is a HTTP probe that queries to the RequestPath of "/health.htm". The query is performed every 5 seconds, as specified by the IntervalInSeconds property. The health probe must receive an HTTP response code of 200 for 8 consecutive queries for the probe to consider the backend IP to be healthy. If the backend IP is not healthy, the load balancer will not send traffic to the IP.

$probe=New-Object Microsoft.Windows.NetworkController.LoadBalancerProbeProperties
$probe.protocol="HTTP"
$probe.port="80"
$probe.RequestPath="/health.htm"
$probe.IntervalInSeconds=5
$probe.NumberofProbes=8
New-NetworkControllerLoadBalancerProbe -ConnectionUri https://networkcontroller -LoadBalancerId lb1 -ResourceId Probe1 -Properties $probe

Parameters

-CertificateThumbPrint

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. This is the certificate thumbprint of the certificate. This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.

Parameter properties

Type:Uri
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

-Credential

Specifies a user credential that has permission to perform this action. The default value is the current user.This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.

Parameter properties

Type:PSCredential
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

-Etag

Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP response header returned by an HTTP-compliant web server used to determine change in the content of a resource at a given URL. The value of the header is an opaque string representing the state of the resource at the time the response was generated.

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

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
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

-LoadBalancerId

Specifies the load balancer where the health probe belongs

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

-PassInnerException

This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

The thumbprint must be provided only if the network controller client authentication is X509 certificates. Get-NetworkController retrieves that client authentication and authorization information.

Parameter properties

Type:SwitchParameter
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

-Properties

Following properties can be added/changed for a load balancer probe:

  • Protocol
  • Port
  • Request path that has to be probed
  • Probe interval (in seconds)
  • Number of retries after which a backend resource is deemed unhealthy

Parameter properties

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

-ResourceId

Specifies the unique ID of the health probe rule

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

-ResourceMetadata

This parameter contains metadata information for the client, such as the tenant ID, group ID, and resource name.

Parameter properties

Type:ResourceMetadata
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

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

Microsoft.Windows.NetworkController.LoadBalancerProbeProperties

Following properties can be added/changed for a load balancer probe:

  • Protocol
  • Port
  • Request path that has to be probed
  • Probe interval (in seconds)
  • Number of retries after which a backend resource is deemed unhealthy

Outputs

Object