Resource Type: dsc_sqlendpoint

Properties

dsc_endpointtype

Specifies the type of endpoint. Currently the only types that are supported are the _Database Mirroring_ and the _Service Broker_ type.
dsc_ensure

If the endpoint should be present or absent. Default values is ‘’Present’‘.
dsc_ipaddress

The network IP address the endpoint is listening on. Default value is ‘’0.0.0.0’‘ which means listen on any valid IP address. The default value is only used during endpoint creation, it is not enforce.
dsc_ismessageforwardingenabled

Specifies whether messages received by this endpoint that are for services located elsewhere will be forwarded.
dsc_messageforwardingsize

Specifies the maximum amount of storage in megabytes to allocate for the endpoint to use when storing messages that are to be forwarded.
dsc_owner

The owner of the endpoint. Default is the login used for the creation.
dsc_port

The network port the endpoint is listening on. Default value is ‘5022`, but default value is only used during endpoint creation, it is not enforce.
dsc_servername

The host name of the SQL Server to be configured. Default value is the current computer name.
dsc_state

Specifies the state of the endpoint. When an endpoint is created and the state is not specified then the endpoint will be started after it is created. The state will not be enforced unless the parameter is specified.

Parameters

dsc_endpointname (namevar)

The name of the endpoint.
dsc_instancename (namevar)

The name of the _SQL Server_ instance to be configured.
dsc_psdscrunascredential
dsc_timeout

The maximum time in seconds to wait for the DSC resource to complete.
name (namevar)

Description of the purpose for this resource declaration.
validation_mode (defaults to: property)

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Overview