[Index]
Model ref.: device/exchangeonline/EmailAddressPolicy
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": {
"ManagedByFilter": {
"__type_requested": "String",
"required": false,
"description": "PARAMVALUE: String",
"title": "ManagedByFilter",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "ManagedByFilter"
},
"HasEmailAddressSetting": {
"__type_requested": "System.Boolean",
"required": false,
"name": "HasEmailAddressSetting",
"title": "HasEmailAddressSetting",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"AdminDisplayName": {
"__type_requested": "System.String",
"required": false,
"name": "AdminDisplayName",
"title": "AdminDisplayName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"OrganizationId": {
"__type_requested": "System.String",
"required": false,
"name": "OrganizationId",
"title": "OrganizationId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"ConditionalStateOrProvince": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The ConditionalStateOrProvince parameter specifies a filter by state or province. It takes multiple values as a comma-delimited list.",
"title": "ConditionalStateOrProvince",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalStateOrProvince"
},
"Priority": {
"__type_requested": "System.String",
"required": false,
"description": "The Priority parameter specifies that the current priority is higher than the priority specified as an argument for this parameter.",
"title": "Priority",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Priority"
},
"WhenCreatedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreatedUTC",
"title": "WhenCreatedUTC",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"PSShowComputerName": {
"__type_requested": "System.Boolean",
"required": false,
"name": "PSShowComputerName",
"title": "PSShowComputerName",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"NonAuthoritativeDomains": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.ProxyAddressTemplateCollection",
"required": false,
"name": "NonAuthoritativeDomains",
"title": "NonAuthoritativeDomains",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"HasMailboxManagerSetting": {
"__type_requested": "System.Boolean",
"required": false,
"name": "HasMailboxManagerSetting",
"title": "HasMailboxManagerSetting",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"ManagedByLdapFilter": {
"__type_requested": "System.String",
"required": false,
"name": "ManagedByLdapFilter",
"title": "ManagedByLdapFilter",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"ConditionalDepartment": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The ConditionalDepartment parameter specifies a filter by department. It takes multiple values as a comma-delimited list.",
"title": "ConditionalDepartment",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalDepartment"
},
"EnabledEmailAddressTemplates": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.ProxyAddressTemplateCollection",
"required": true,
"description": "The EnabledEmailAddressTemplates parameter specifies the proxy addresses included in an email address policy and are enabled. Separate multiple values with commas. The domain part of each proxy address needs to match an existing accepted domain.",
"title": "EnabledEmailAddressTemplates",
"__type_mapping_type": "Unknown",
"name": "EnabledEmailAddressTemplates",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"PSComputerName": {
"__type_requested": "System.String",
"required": false,
"name": "PSComputerName",
"title": "PSComputerName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"ConditionalCustomAttribute8": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute8",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute8"
},
"ConditionalCustomAttribute9": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute9",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute9"
},
"ConditionalCustomAttribute2": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute2",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute2"
},
"ConditionalCustomAttribute3": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute3",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute3"
},
"ConditionalCustomAttribute1": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute1",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute1"
},
"ConditionalCustomAttribute6": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute6",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute6"
},
"ConditionalCustomAttribute7": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute7",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute7"
},
"ConditionalCustomAttribute4": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute4",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute4"
},
"ConditionalCustomAttribute5": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute5",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute5"
},
"DistinguishedName": {
"__type_requested": "System.String",
"required": false,
"name": "DistinguishedName",
"title": "DistinguishedName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"OriginatingServer": {
"__type_requested": "System.String",
"required": false,
"name": "OriginatingServer",
"title": "OriginatingServer",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"ExchangeVersion": {
"__type_requested": "System.String",
"required": false,
"name": "ExchangeVersion",
"title": "ExchangeVersion",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"Name": {
"__type_requested": "String",
"required": true,
"description": "The Name parameter specifies the name of the email address policy.",
"title": "Name",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Name"
},
"ConditionalCustomAttribute14": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute14",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute14"
},
"ConditionalCustomAttribute15": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute15",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute15"
},
"ConditionalCustomAttribute10": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute10",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute10"
},
"ConditionalCustomAttribute11": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute11",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute11"
},
"IncludedRecipients": {
"__type_requested": "System.String",
"required": true,
"description": "The IncludedRecipients parameter specifies how to filter recipients used to set the email address policy. The AllRecipients value can be used only by itself. When multiple values of the IncludedRecipients parameter are separated by commas, the OR Boolean operator is applied.",
"title": "IncludedRecipients",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "IncludedRecipients"
},
"ConditionalCustomAttribute13": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute13",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute13"
},
"LdapRecipientFilter": {
"__type_requested": "System.String",
"required": false,
"name": "LdapRecipientFilter",
"title": "LdapRecipientFilter",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"WhenCreated": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreated",
"title": "WhenCreated",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"DisabledEmailAddressTemplates": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.ProxyAddressTemplateCollection",
"required": false,
"description": "The DisabledEmailAddressTemplates parameter specifies the proxy addresses included in an email address policy and are disabled. It takes multiple values as a comma-delimited list.",
"title": "DisabledEmailAddressTemplates",
"__type_mapping_type": "Unknown",
"name": "DisabledEmailAddressTemplates",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"ConditionalCustomAttribute12": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "This parameter specifies a filter that's based on the value of the recipient's CustomAttribute1 to CustomAttribute15 property. For example, if you set the ConditionalCustomAttribute1 parameter to the value Marketing, all recipients whose CustomAttribute1 value is Marketing are included in this filter. You can specify multiple values separated by commas.\nWhen you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic.\nYou can't use this parameter with the RecipientFilter parameter. You need to use the IncludedRecipients parameter with a Conditional parameter.",
"title": "ConditionalCustomAttribute12",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCustomAttribute12"
},
"AdminDescription": {
"__type_requested": "System.String",
"required": false,
"name": "AdminDescription",
"title": "AdminDescription",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"IncludeUnifiedGroupRecipients": {
"__type_requested": "SwitchParameter",
"required": true,
"description": "PARAMVALUE: SwitchParameter",
"title": "IncludeUnifiedGroupRecipients",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "IncludeUnifiedGroupRecipients"
},
"ConditionalCompany": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The ConditionalCompany parameter specifies a filter by company. It takes multiple values as a comma-delimited list.",
"title": "ConditionalCompany",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "ConditionalCompany"
},
"DomainController": {
"__type_requested": "Fqdn",
"required": false,
"description": "The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.",
"title": "DomainController",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "DomainController"
},
"ObjectCategory": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectCategory",
"title": "ObjectCategory",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"RecipientFilterApplied": {
"__type_requested": "System.Boolean",
"required": false,
"name": "RecipientFilterApplied",
"title": "RecipientFilterApplied",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"RecipientFilter": {
"__type_requested": "String",
"required": true,
"description": "The RecipientFilter parameter specifies a filter for recipients to include in the email address policy. You can't use this parameter if you use any of the following filter parameters:\nConditionalCompany\nConditionalDepartment\nIncludedRecipients\nConditionalStateOrProvince",
"title": "RecipientFilter",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "RecipientFilter"
},
"LastUpdatedRecipientFilter": {
"__type_requested": "System.String",
"required": false,
"name": "LastUpdatedRecipientFilter",
"title": "LastUpdatedRecipientFilter",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"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"
},
"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"
},
"ObjectState": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectState",
"title": "ObjectState",
"__type_mapping_type": "String",
"readonly": true,
"type": "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 GUID, distinguished name (DN), or email address policy name that represents a specific email address policy. You can also include the path using the format Path\\EmailAddressPolicy.\nYou can omit the parameter label Identity so that only the GUID, DN, or email address policy name is supplied."
},
"IsValid": {
"__type_requested": "System.Boolean",
"required": false,
"name": "IsValid",
"title": "IsValid",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"RecipientFilterType": {
"__type_requested": "System.String",
"required": false,
"name": "RecipientFilterType",
"title": "RecipientFilterType",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"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"
},
"RecipientContainer": {
"__type_requested": "",
"required": false,
"description": "The RecipientContainer parameter specifies how to filter the recipients used to build the email address policies based on their location in Active Directory Domain Services (AD DS). The value of the RecipientContainer parameter can be the canonical name of an organizational unit (OU) or a domain. If you don't specify a value for the RecipientContainer parameter, the default search filter is the location of the dynamic distribution group in AD DS.",
"title": "RecipientContainer",
"__type_mapping_type": "Unknown",
"name": "RecipientContainer",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"Id": {
"__type_requested": "System.String",
"required": false,
"name": "Id",
"title": "Id",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"EnabledPrimarySMTPAddressTemplate": {
"__type_requested": "String",
"required": true,
"description": "The EnabledPrimarySMTPAddressTemplate parameter specifies the proxy address enabled and included in an email address policy. The domain part of each proxy address needs to match an existing accepted domain.",
"title": "EnabledPrimarySMTPAddressTemplate",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "EnabledPrimarySMTPAddressTemplate"
}
},
"schema_version": "2017.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/exchangeonline/EmailAddressPolicy/add/ |
|
The GUI Add form of device/exchangeonline/EmailAddressPolicy 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/exchangeonline/EmailAddressPolicy/ | 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/exchangeonline/EmailAddressPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangeonline/EmailAddressPolicy/[pkid1]", "/api/device/exchangeonline/EmailAddressPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangeonline/EmailAddressPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/exchangeonline/EmailAddressPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/exchangeonline/EmailAddressPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangeonline/EmailAddressPolicy/[pkid1]", "/api/v0/device/exchangeonline/EmailAddressPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangeonline/EmailAddressPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangeonline/EmailAddressPolicy |
|
{"hrefs": ["/api/device/exchangeonline/EmailAddressPolicy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangeonline/EmailAddressPolicy |
|
{"hrefs": ["/api/device/exchangeonline/EmailAddressPolicy/[pkid1]", "/api/device/exchangeonline/EmailAddressPolicy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangeonline/EmailAddressPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangeonline/EmailAddressPolicy/export/ |
|
{ "hrefs":["/api/device/exchangeonline/EmailAddressPolicy/[pkid1]", "/api/device/exchangeonline/EmailAddressPolicy/[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/exchangeonline/EmailAddressPolicy and the JSON format can be used to import instances of device/exchangeonline/EmailAddressPolicy.
GET http://[host-proxy]/api/device/exchangeonline/EmailAddressPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/exchangeonline/EmailAddressPolicy | POST | /api/device/exchangeonline/EmailAddressPolicy/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/exchangeonline/EmailAddressPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/exchangeonline/EmailAddressPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/exchangeonline/EmailAddressPolicy/ |
|
The device/exchangeonline/EmailAddressPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangeonline/EmailAddressPolicy instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "Name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/exchangeonline/EmailAddressPolicy/?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": "2017.1",
"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/exchangeonline/EmailAddressPolicy/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/exchangeonline/EmailAddressPolicy/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/exchangeonline/EmailAddressPolicy/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/exchangeonline/EmailAddressPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/exchangeonline/EmailAddressPolicy/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/exchangeonline/EmailAddressPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/exchangeonline/EmailAddressPolicy/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/exchangeonline/EmailAddressPolicy/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/exchangeonline/EmailAddressPolicy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/exchangeonline/EmailAddressPolicy/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/exchangeonline/EmailAddressPolicy/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/exchangeonline/EmailAddressPolicy",
"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": "20.1.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/exchangeonline/EmailAddressPolicy. | GET | /api/device/exchangeonline/EmailAddressPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangeonline/EmailAddressPolicy as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/exchangeonline/EmailAddressPolicy/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/exchangeonline/EmailAddressPolicy/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangeonline/EmailAddressPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangeonline/EmailAddressPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangeonline/EmailAddressPolicy | 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/exchangeonline/EmailAddressPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangeonline/EmailAddressPolicy/[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/exchangeonline/EmailAddressPolicy and the JSON format can be used to import instances of device/exchangeonline/EmailAddressPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/exchangeonline/EmailAddressPolicy/[pkid]/ | hierarchy=[hierarchy] | The device/exchangeonline/EmailAddressPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/exchangeonline/EmailAddressPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangeonline/EmailAddressPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangeonline/EmailAddressPolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |