[Index]
Model ref.: device/exchangehybrid/SendConnector
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "SmartHosts": { "__type_requested": "MultiValuedProperty", "required": false, "description": "The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameteris required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart-host server.\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.", "title": "SmartHosts", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "SmartHosts" }, "AdminDisplayName": { "__type_requested": "System.String", "required": false, "name": "AdminDisplayName", "title": "AdminDisplayName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ForceHELO": { "__type_requested": "$true | $false", "required": false, "description": "The ForceHELO parameter specifies whether HELO is sent instead of the default EHLO. Valid values are $true or $false. The default value is $false.", "title": "ForceHELO", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "ForceHELO" }, "TlsCertificateName": { "__type_requested": "System.String", "required": false, "description": "The TlsCertificateName parameter specifies the X.509 certificate to use with TLS sessions and secure mail. Valid input for this parameter is [I]Issuer[S]Subject. The Issuer value is found in the certificate's Issuer field, and the Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet.", "title": "TlsCertificateName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "TlsCertificateName" }, "OrganizationId": { "__type_requested": "System.String", "required": false, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "RequireOorg": { "__type_requested": "$true | $false", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "RequireOorg", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "RequireOorg" }, "Port": { "__type_requested": "Int32", "required": false, "description": "The Port parameter specifies the port number for smart host forwarding, if you specify a value in the SmartHosts parameter. The valid input range is an integer from 0 through 65535. The default value is 25. In most organizations, the port number is set to 25.", "title": "Port", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "Port" }, "SourceRoutingGroup": { "__type_requested": "System.String", "required": false, "name": "SourceRoutingGroup", "title": "SourceRoutingGroup", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Custom": { "__type_requested": "SwitchParameter", "required": false, "description": "The Custom parameter specifies the Custom usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Custom parameter, you can't use any of the following parameters:\nInternal\nInternet\nPartner\nUsage\nFor more information about Send connector usage types, permissions, and authentication methods, see Send connectors.", "title": "Custom", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Custom" }, "ConnectionInactivityTimeOut": { "__type_requested": "System.String", "required": false, "description": "The ConnectionInactivityTimeOut parameter specifies the maximum time an idle connection can remain open. The default value is ten minutes.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify fifteen minutes, set it to 00:15:00. The valid input range for this parameter is 00:00:01 to 1.00:00:00.", "title": "ConnectionInactivityTimeOut", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ConnectionInactivityTimeOut" }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "Internal": { "__type_requested": "SwitchParameter", "required": false, "description": "The Internal parameter specifies the Internal usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internal parameter, you can't use any of the following parameters:\nCustom\nInternet\nPartner\nUsage\nFor more information about Send connector usage types, permissions, and authentication methods, see Send connectors.", "title": "Internal", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Internal" }, "Internet": { "__type_requested": "SwitchParameter", "required": false, "description": "The Internet parameter specifies the Internet usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internet parameter, you can't use any of the following parameters:\nCustom\nInternal\nPartner\nUsage\nFor more information about Send connector usage types, permissions, and authentication methods, see Send connectors.", "title": "Internet", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Internet" }, "Usage": { "__type_requested": "Custom | Internal | Internet | Partner", "required": false, "description": "The Usage parameter specifies the default permissions and authentication methods assigned to the Send connector. The valid values are as follows: Custom, Internal, Internet, or Partner. The default is Custom.\nIf you use the Usage parameter, you can't use any of the following parameters:\nCustom\nInternal\nInternet\nPartner\nFor more information about Send connector usage types, permissions, and authentication methods, see Send connectors.", "title": "Usage", "__type_mapping_type": "Unknown", "name": "Usage", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "SourceIPAddress": { "__type_requested": "System.Net.IPAddress", "required": false, "description": "The SourceIPAddress parameter specifies the local IP address to use as the endpoint for an SMTP connection to a remote messaging server. The default IP address is 0.0.0.0. This value means that the server can use any available local IP address. This parameter is valid only for Send connectors configured on an Edge server.", "title": "SourceIPAddress", "__type_mapping_type": "Unknown", "name": "SourceIPAddress", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "CloudServicesMailEnabled": { "__type_requested": "$true | $false", "required": false, "description": "Set to $true to enable this connector to send messages to the cloud service.", "title": "CloudServicesMailEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "CloudServicesMailEnabled" }, "SourceTransportServers": { "__type_requested": "MultiValuedProperty", "required": false, "description": "The SourceTransportServers parameter specifies the names of the Mailbox servers that can use this Send connector. This parameter isn't valid for Send connectors configured on an Edge server.\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.", "title": "SourceTransportServers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "SourceTransportServers" }, "ProtocolLoggingLevel": { "__type_requested": "System.String", "required": false, "description": "The ProtocolLoggingLevel parameter specifies whether to enable protocol logging. Verbose enables protocol logging. None disables protocol logging. The location of the Send connector protocol logs for all Send connectors configured in the Transport service on a Mailbox server or on an Edge server is specified with the SendProtocolLogPath parameter of the Set-TransportService cmdlet.", "title": "ProtocolLoggingLevel", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ProtocolLoggingLevel" }, "ObjectClass": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ObjectClass", "title": "ObjectClass", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "ErrorPolicies": { "__type_requested": "System.String", "required": false, "description": "The ErrorPolicies parameter specifies how communication errors are treated. Possible values are the following:\nDefault A non-delivery report (NDR) is generated for communication errors.\nDowngradeDnsFailures All DNS errors are treated as transient.\nDowngradeCustomFailures Particular SMTP errors are treated as transient.\nUpgradeCustomFailures Custom transient failures are upgraded and treated as permanent failures.\nMultiple values can be specified for this parameter, separated by commas.\nSpecify a value other than Default for this parameter only if this Send connector is used to send messages over a reliable and well-defined communication channel where communication errors aren't expected. For example, consider specifying a value other than Default if this Send connector is used to send messages to a partner.", "title": "ErrorPolicies", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ErrorPolicies" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "TlsAuthLevel": { "__type_requested": "System.String", "required": false, "description": "The TlsAuthLevel parameter specifies the TLS authentication level that is used for outbound TLS connections established by this Send connector. Valid values are:\nEncryptionOnly: TLS is used only to encrypt the communication channel. No certificate authentication is performed.\nCertificateValidation: TLS is used to encrypt the channel and certificate chain validation and revocation lists checks are performed.\nDomainValidation: In addition to channel encryption and certificate validation, the Send connector also verifies that the FQDN of the target certificate matches the domain specified in the TlsDomain parameter. If no domain is specified in the TlsDomain parameter, the FQDN on the certificate is compared with the recipient's domain.\nYou can't specify a value for this parameter if the IgnoreSTARTTLS parameter is set to $true, or if the RequireTLS parameter is set to $false.", "title": "TlsAuthLevel", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "TlsAuthLevel" }, "SmartHostAuthMechanism": { "__type_requested": "System.String", "required": false, "description": "The SmartHostAuthMechanism parameter specifies the smart host authentication mechanism to use for authentication with a remote server. Use this parameter only when a smart host is configured and the DNSRoutingEnabled parameter is set to $false. Valid values are None, BasicAuth, BasicAuthRequireTLS, ExchangeServer, and ExternalAuthoritative. All values are mutually exclusive. If you select BasicAuth or BasicAuthRequireTLS, you must use the AuthenticationCredential parameter to specify the authentication credential.", "title": "SmartHostAuthMechanism", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "SmartHostAuthMechanism" }, "IsSmtpConnector": { "__type_requested": "System.Boolean", "required": false, "name": "IsSmtpConnector", "title": "IsSmtpConnector", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ConnectedDomains": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[Microsoft.Exchange.Data.ConnectedDomain,", "required": false, "name": "ConnectedDomains", "title": "ConnectedDomains", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Identity": { "__type_requested": "System.String", "required": false, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The Identity parameter specifies the name, or GUID of the Send connector. If the Identity name contains spaces, enclose the name in quotation marks (\"). You can omit the Identity parameter label. You can also include the server name by using the format ServerName\\ConnectorName." }, "DistinguishedName": { "__type_requested": "System.String", "required": false, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Comment": { "__type_requested": "String", "required": false, "description": "The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks (\"), for example: \"This is an admin note\".", "title": "Comment", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Comment" }, "OriginatingServer": { "__type_requested": "System.String", "required": false, "name": "OriginatingServer", "title": "OriginatingServer", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Name": { "__type_requested": "String", "required": true, "description": "The Name parameter specifies a descriptive name for the connector.", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "AddressSpaces": { "__type_requested": "MultiValuedProperty", "required": true, "description": "The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is as follows: <AddressSpaceType>:<AddressSpace>;<AddressSpaceCost>\nAddressSpaceType: On an Edge server, the address space type must be SMTP. In the Transport service on a Mailbox server, the address space type may be SMTP, X400, or any other text string. If you omit the address space type, SMTP is assumed.\nAddressSpace: For SMTP address space types, the address space that you enter must be RFC 1035-compliant. For example, *, *.com, and *.contoso.com are permitted, but *contoso.com is not. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such as o=MySite;p=MyOrg;a=adatum;c=us. For all other values of address space type, you can enter any text for the address space.\nAddressSpaceCost: The valid input range for the cost is from 1 through 100. A lower cost indicates a better route. This parameter is optional. If you omit the address space cost, a cost of 1 is assumed. If you enter a non-SMTP address space that contains the semicolon character (;), you must specify the address space cost.\nIf you specify the address space type or the address space cost, you must enclose the address space in quotation marks (\"). For example, the following address space entries are equivalent:\n\"SMTP:contoso.com;1\"\n\"contoso.com;1\"\n\"SMTP:contoso.com\"\ncontoso.com\nYou may specify multiple address spaces by separating the address spaces with commas, for example: contoso.com,fabrikam.com. If you specify the address space type or the address space cost, enclose the address space in quotation marks (\"), for example: \"contoso.com;2\",\"fabrikam.com;3\".\nIf you specify a non-SMTP address space type on a Send connector configured in the Transport service on a Mailbox server, you must configure the following parameters:\nThe SmartHosts parameter must be set to a value that specifies a smart host.\nThe DNSRoutingEnabled parameter must be set to $false.\nAlthough you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as third-party fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see Foreign connectors.", "title": "AddressSpaces", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "AddressSpaces" }, "Enabled": { "__type_requested": "$true | $false", "required": false, "description": "The Enabled parameter specifies whether to enable the Send connector to process email messages. Valid values are $true or $false. The default value is $true.", "title": "Enabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Enabled" }, "Fqdn": { "__type_requested": "Fqdn", "required": false, "description": "The Fqdn parameter specifies the FQDN used as the source server for connected messaging servers that use the Send connector to receive outgoing messages. The value of this parameter is displayed to connected messaging servers whenever a source server name is required, as in the following examples:\nIn the EHLO/HELO command when the Send connector communicates with the next hop messaging server\nIn the most recent Received header field added to the message by the next hop messaging server after the message leaves the Transport service on a Mailbox server or an Edge server\nDuring TLS authentication\nThe default value of the Fqdn parameter is $null. This means the default FQDN value is the FQDN of the Mailbox server or Edge server that contains the Send connector.", "title": "Fqdn", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Fqdn" }, "IgnoreSTARTTLS": { "__type_requested": "$true | $false", "required": false, "description": "The IgnoreSTARTTLS parameter specifies whether to ignore the StartTLS option offered by a remote sending server. This parameter is used with remote domains. This parameter must be set to $false if the RequireTLS parameter is set to $true. Valid values for this parameter are $true or $false.", "title": "IgnoreSTARTTLS", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "IgnoreSTARTTLS" }, "DomainSecureEnabled": { "__type_requested": "$true | $false", "required": false, "description": "The DomainSecureEnabled parameter enables mutual Transport Layer Security (TLS) authentication for the domains serviced by the Send connector when set to $true. Mutual TLS authentication functions correctly only if the following conditions are met:\nDomainSecureEnabled is set to $true.\nDNSRoutingEnabled is set to $true.\nIgnoreSTARTTLS is set to $false.\nThe wildcard character (*) isn't supported in domains configured for mutual TLS authentication. The same domain must also be defined on the corresponding Receive connector, and in the value of the TLSReceiveDomainSecureList attribute of the transport configuration.\nThe default value for the DomainSecureEnabled parameter is $false for the following types of Send connectors:\nThose defined in the Transport service on a Mailbox server.\nUser-created Send connectors defined on an Edge server.\nThe default value is $true for a default Send connector defined on an Edge server.", "title": "DomainSecureEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "DomainSecureEnabled" }, "MaxMessageSize": { "__type_requested": "System.String", "required": false, "description": "The MaxMessageSize parameter specifies the maximum size of a message that can pass through a connector. The default value is 25 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nValues entered in bytes are rounded up to nearest kilobyte. The valid input range for this parameter is 0 to 2147483647 bytes. To remove the message size limit on a Send connector, enter a value of unlimited.", "title": "MaxMessageSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "MaxMessageSize" }, "FrontendProxyEnabled": { "__type_requested": "$true | $false", "required": false, "description": "The FrontendProxyEnabled parameter routes outbound messages through the CAS server, where destination specific routing, such as DNS or IP address, is set, when the parameter is set to $true.", "title": "FrontendProxyEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "FrontendProxyEnabled" }, "UseExternalDNSServersEnabled": { "__type_requested": "$true | $false", "required": false, "description": "The UseExternalDNSServersEnabled parameter specifies whether this Send connector uses the external DNS list specified by the ExternalDNSServers parameter of the Set-TransportService cmdlet. The default value is $false.", "title": "UseExternalDNSServersEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "UseExternalDNSServersEnabled" }, "ExchangeVersion": { "__type_requested": "System.String", "required": false, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "TlsDomain": { "__type_requested": "System.String", "required": false, "description": "The TlsDomain parameter specifies the domain name that the Send connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection.\nThis parameter is used only if the TlsAuthLevel parameter is set to DomainValidation.\nA value for this parameter is required if:\nThe TLSAuthLevel parameter is set to DomainValidation.\nThe DNSRoutingEnabled parameter is set to $false (smart host Send connector).", "title": "TlsDomain", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "TlsDomain" }, "IsScopedConnector": { "__type_requested": "$true | $false", "required": false, "description": "The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers with the Transport service. When the value of this parameter is $false, the connector can be used by all Mailbox servers in the Exchange organization. When the value of this parameter is $true, the connector can only be used by Transport service on Mailbox servers in the same Active Directory site. The default value is $false.", "title": "IsScopedConnector", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "IsScopedConnector" }, "HomeMtaServerId": { "__type_requested": "System.String", "required": false, "name": "HomeMtaServerId", "title": "HomeMtaServerId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "SmartHostsString": { "__type_requested": "System.String", "required": false, "name": "SmartHostsString", "title": "SmartHostsString", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DomainController": { "__type_requested": "Fqdn", "required": false, "description": "The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.\nThe DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.", "title": "DomainController", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DomainController" }, "DNSRoutingEnabled": { "__type_requested": "$true | $false", "required": false, "description": "The DNSRoutingEnabled parameter specifies whether the Send connector uses Domain Name System (DNS) to route mail. Valid values for this parameter are $true or $false. The default value is $true. If you specify a SmartHosts parameter, the DNSRoutingEnabled parameter must be $false.", "title": "DNSRoutingEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "DNSRoutingEnabled" }, "RequireTLS": { "__type_requested": "$true | $false", "required": false, "description": "The RequireTLS parameter specifies whether all messages sent through this connector must be transmitted using TLS. The default value is $false.", "title": "RequireTLS", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "RequireTLS" }, "ObjectCategory": { "__type_requested": "System.String", "required": false, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "HomeMTA": { "__type_requested": "System.String", "required": false, "name": "HomeMTA", "title": "HomeMTA", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "IsValid": { "__type_requested": "System.Boolean", "required": false, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "WhenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChanged", "title": "WhenChanged", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "WhenChangedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChangedUTC", "title": "WhenChangedUTC", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "ObjectState": { "__type_requested": "System.String", "required": false, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "CertificateSubject": { "__type_requested": "", "required": false, "name": "CertificateSubject", "title": "CertificateSubject", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SmtpMaxMessagesPerConnection": { "__type_requested": "Int32", "required": false, "description": "The SmtpMaxMessagesPerConnection parameter specifies the maximum number of messages the server can send per connection.", "title": "SmtpMaxMessagesPerConnection", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "SmtpMaxMessagesPerConnection" }, "Partner": { "__type_requested": "SwitchParameter", "required": false, "description": "The Partner parameter specifies the Partner usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Partner parameter, you can't use any of the following parameters:\nCustom\nInternal\nInternet\nUsage\nFor more information about Send connector usage types, permissions, and authentication methods, see Send connectors.", "title": "Partner", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Partner" }, "RunspaceId": { "__type_requested": "System.Guid", "required": false, "name": "RunspaceId", "title": "RunspaceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Guid": { "__type_requested": "System.Guid", "required": false, "name": "Guid", "title": "Guid", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Id": { "__type_requested": "System.String", "required": false, "name": "Id", "title": "Id", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "AuthenticationCredential": { "__type_requested": "", "required": false, "description": "The AuthenticationCredential parameter specifies a credential object. This credential object is created by using the Get-Credential cmdlet. For more information about the Get-Credential cmdlet, enter Get-Help Get-Credential in the Exchange Management Shell.", "title": "AuthenticationCredential", "__type_mapping_type": "Unknown", "name": "AuthenticationCredential", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchangehybrid/SendConnector/add/ |
|
The GUI Add form of device/exchangehybrid/SendConnector as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/device/exchangehybrid/SendConnector/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/exchangehybrid/SendConnector/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangehybrid/SendConnector/[pkid1]", "/api/device/exchangehybrid/SendConnector/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangehybrid/SendConnector/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/SendConnector/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/SendConnector/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/SendConnector/[pkid1]", "/api/v0/device/exchangehybrid/SendConnector/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/SendConnector/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/SendConnector |
|
{"hrefs": ["/api/device/exchangehybrid/SendConnector/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/SendConnector |
|
{"hrefs": ["/api/device/exchangehybrid/SendConnector/[pkid1]", "/api/device/exchangehybrid/SendConnector/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/SendConnector; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/SendConnector/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/SendConnector/[pkid1]", "/api/device/exchangehybrid/SendConnector/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/exchangehybrid/SendConnector and the JSON format can be used to import instances of device/exchangehybrid/SendConnector.
GET http://[host-proxy]/api/device/exchangehybrid/SendConnector/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/SendConnector | POST | /api/device/exchangehybrid/SendConnector/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/exchangehybrid/SendConnector/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchangehybrid/SendConnector/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/SendConnector/ |
|
The device/exchangehybrid/SendConnector schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/SendConnector instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/SendConnector/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "15312", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/exchangehybrid/SendConnector/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangehybrid/SendConnector/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangehybrid/SendConnector/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangehybrid/SendConnector", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/SendConnector/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/exchangehybrid/SendConnector/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/SendConnector/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/SendConnector/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/SendConnector/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/SendConnector/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/SendConnector/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/SendConnector", "model_specific_actions": [ "get", "list", "add", "remove", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "Name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/exchangehybrid/SendConnector. | GET | /api/device/exchangehybrid/SendConnector/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/SendConnector as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangehybrid/SendConnector/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/exchangehybrid/SendConnector/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/SendConnector/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/SendConnector/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/SendConnector | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of device/exchangehybrid/SendConnector; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/SendConnector/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/exchangehybrid/SendConnector and the JSON format can be used to import instances of device/exchangehybrid/SendConnector.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/SendConnector/[pkid]/ | hierarchy=[hierarchy] | The device/exchangehybrid/SendConnector instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/SendConnector/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/SendConnector. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/SendConnector/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |