MicrosoftPlaces.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>MicrosoftPlaces</name> </assembly> <members> <member name="M:MicrosoftPlaces.BasePSCmdlet.TraceError(System.Management.Automation.ErrorRecord)"> <summary> Traces the error. </summary> <param name="errorRecord">The error record.</param> </member> <member name="M:MicrosoftPlaces.BasePSCmdlet.TraceInvalidArgument(System.String)"> <summary> Traces invalid argument errors. </summary> <param name="message">The message to associate with the invalid argument error.</param> </member> <member name="M:MicrosoftPlaces.BasePSCmdlet.GetServiceHostUri(System.String,System.String)"> <summary> Gets the service host Uri. </summary> <returns> servicehost Uri.</returns> </member> <member name="M:MicrosoftPlaces.BasePSCmdlet.InitializeServiceParameters"> <summary> Init common cmdlet configuration and generate the access token. </summary> </member> <member name="M:MicrosoftPlaces.AdalAccessToken.GetAccessToken"> <summary> Get Access Token asynchronously using MSAL auth Get Access Token for various scenarios 1. Context.CredentialUserName and Context.CredentialPassword is present : Then a new token is created based on the values. -No UI based browser redirect 2. If its device auth get the code and print it out and then wait for user to enter it in browser 3. Context.CredentialUserName is present and Context.CredentialPassword is null. It then lands the user automatically to a browser. 4. Context.UserPrincipalName is present : It takes it up as hint and lands him to browser with that UPN populated. 5. Context.UserPrincipalName is null : It takes it up as hint and lands him to browser asking for selecting a account or entering UPN. </summary> <returns>Returns AccessToken</returns> </member> <member name="M:MicrosoftPlaces.AdalAccessToken.Dispose"> <summary> Dispose method - removes the delegate. </summary> </member> <member name="M:MicrosoftPlaces.AdalAccessToken.InvokeCancellation"> <summary> Method to invoke cancellation of token acquisition </summary> </member> <member name="M:MicrosoftPlaces.ArgumentValidator.ThrowIfNull(System.String,System.Object)"> <summary> Helper to throw if the argument is null. </summary> <param name="name">Name of the argument.</param> <param name="arg">Argument to test.</param> </member> <member name="M:MicrosoftPlaces.ArgumentValidator.ThrowIfNullOrEmpty(System.String,System.String)"> <summary> Helper to throw if the argument is empty. </summary> <param name="name">Name of the argument.</param> <param name="arg">Argument to test.</param> </member> <member name="T:MicrosoftPlaces.AuthType"> <summary> Auth types </summary> </member> <member name="F:MicrosoftPlaces.AuthType.Default"> <summary> Log in using default auth i.e. MSI auth for .netstandard 2.0 and normal auth otherwise </summary> </member> <member name="F:MicrosoftPlaces.AuthType.Device"> <summary> Log in using device auth Valid only for Cloud Shell .netstandard 2.0 </summary> </member> <member name="T:MicrosoftPlaces.CachedCmdletSession"> <summary> Json serialization class for Session cache data </summary> </member> <member name="F:MicrosoftPlaces.CachedCmdletSession.TokenSpanInHours"> <summary> The token lifespan in hours. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.Token"> <summary> Gets or sets the token. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.UserSmtpAddress"> <summary> Gets or sets the user SMTP address. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.TenantId"> <summary> Gets or sets the tenantId from the authenticated user. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.Timestamp"> <summary> Gets or sets the timestamp. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.IsTorusCommand"> <summary> Gets or sets the token. </summary> </member> <member name="P:MicrosoftPlaces.CachedCmdletSession.IsActive"> <summary> Gets a value indicating whether this <see cref="T:MicrosoftPlaces.CachedCmdletSession"/> is still valid. </summary> </member> <member name="T:MicrosoftPlaces.CmdletConfiguration"> <summary> This class stores the settings data deserialized from CmdletSettings.json. </summary> </member> <member name="P:MicrosoftPlaces.CmdletConfiguration.EnvironmentConfigurations"> <summary> List of Environment Configurations. </summary> </member> <member name="M:MicrosoftPlaces.CmdletSession.DisconnectCmdletSession"> <summary> Closes the current session cleaning variables and removing session file if exists. </summary> </member> <member name="F:MicrosoftPlaces.Constants.CmdletSettings"> <summary> The json file with all the settings. </summary> </member> <member name="F:MicrosoftPlaces.Constants.SessionCacheFilename"> <summary> The session cache filename. </summary> </member> <member name="F:MicrosoftPlaces.Constants.AuthorizationHeaderName"> <summary> The header for the Authorization. </summary> </member> <member name="F:MicrosoftPlaces.Constants.UserAgentHeaderName"> <summary> The header for the user agent. </summary> </member> <member name="F:MicrosoftPlaces.Constants.HostHeaderName"> <summary> The header for the host. </summary> </member> <member name="F:MicrosoftPlaces.Constants.LocalHostHeaderValue"> <summary> The value to pass in the host header for local TdfDev execution. </summary> </member> <member name="F:MicrosoftPlaces.Constants.UserAgentHeaderValue"> <summary> The const value for the user agent. </summary> </member> <member name="F:MicrosoftPlaces.Constants.TorusUserSuffix"> <summary> Torus related constants. </summary> </member> <member name="F:MicrosoftPlaces.Constants.NoConnected"> <summary> Messages shown as result or exceptions in Cmdlets </summary> </member> <member name="T:MicrosoftPlaces.EnvironmentConfiguration"> <summary> This class stores the cmdlet settings for various services for a single environment. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.DefaultEnvironmentType"> <summary> Default environment type if you don't specify environment. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.EnvironmentType"> <summary> Environment type (PROD, INT, DOD, GCCH, Gallatin etc). </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.ResourceId"> <summary> ResourceId. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.AADAuthority"> <summary> AAD Authority. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.ClientId"> <summary> ClientId. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.RedirectUri"> <summary> RedirectUri. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.Host"> <summary> Environment host. </summary> </member> <member name="P:MicrosoftPlaces.EnvironmentConfiguration.AdminApiHost"> <summary> Environment adminApi host. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.Environment"> <summary> Environment parameter is used to load app settings based on the environment where the command is being runned from. Mostly used for Dev / local test to load TDF settings instead of prod. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.AccessToken"> <summary> Parameter to add a custom access token to the session. Just valid on TDS, ignored for all other environments. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.SmtpAddress"> <summary> Parameter to add a custom smtp address to the session. Just valid on TDS, ignored for all other environments. </summary> </member> <member name="P:MicrosoftPlaces.ConnectPsCmdlet.TenantId"> <summary> Parameter to add a custom tenant id to the session. Just valid on TDS, ignored for all other environments. </summary> </member> <member name="M:MicrosoftPlaces.ConnectPsCmdlet.InitializeServiceParameters"> <summary> Init common cmdlet configuration and initialize CdmletSession instance. </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalyticsPSCmdlet.UseLocalHost"> <summary> Used for debugging purposes. If set, the cmdlet will use localhost instead of the production service. </summary> </member> <member name="M:MicrosoftPlaces.PlacesAnalyticsPSCmdlet.HandleLocalHostRequest(System.Net.Http.HttpRequestMessage)"> <summary> Adds an authorization header to the request that will work with our TDF tenant. </summary> <param name="request"></param> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDataset.Type"> <summary> The dataset from which to download data. </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDataset.PushDate"> <summary> The date on which the requested data was previously pushed. Should be in YYYY-MM-dd format, e.g. "2023-07-29". </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDataset.OutputDirectory"> <summary> The directory to which to write the downloaded csv file. </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDataset.Filename"> <summary> The name of the file to download. </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDatasetStatus.Type"> <summary> The dataset from which to download data. </summary> </member> <member name="P:MicrosoftPlaces.PlacesAnalytics.GetDatasetStatus.PushDate"> <summary> The date on which the requested data was previously pushed. Should be in YYYY-MM-dd format, e.g. "2023-07-29". </summary> </member> <member name="T:MicrosoftPlaces.PlacesAnalytics.PushDataset"> <summary> Cmdlet used to batch-upload telemetry data to PAS. Sample usage: <c>Push-Dataset -Type RoomOccupancy -Path C:\sensordata\ -DeviceType Standard</c>. </summary> </member> <member name="M:MicrosoftPlaces.PlacesAnalytics.SubmitPlacesAnalyticsData.CallLocalHost(System.Byte[])"> <summary> Calls PlacesAnalytics service running on local host for testing. Content will be uploaded to ADLS under this.MockTid name in PlacesPartners container. </summary> <param name="fileContent">Zip file including data and metadata, in byte array.</param> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.HttpClient"> <summary> The HTTP client </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.Url"> <summary> The URL </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.JsonContentType"> <summary> The json content type </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.AuthScheme"> <summary> The authentication scheme </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.MockToken"> <summary> The mock token for development. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.ClientRequestIdHeader"> <summary> The client request identifier header </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevicesPSCmdlet.UnknownErrorMessage"> <summary> The unknown error message </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevicesPSCmdlet.IsDev"> <summary> Dev switch to enable local dev execution. Mostly used for Visual Studio launching. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetResourceUri"> <summary> Get the uri based on the environment </summary> <returns></returns> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetDeviceApiHeaders"> <summary> Gets the device API headers. </summary> <returns>The headers.</returns> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetHttpRequestMessage(System.Net.Http.HttpMethod,System.Uri,System.String)"> <summary> Gets the HTTP request message. </summary> <returns>The http request message.</returns> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.SendHttpRequest(System.Net.Http.HttpRequestMessage,System.Action{System.Net.Http.HttpResponseMessage},System.Action{System.Net.Http.HttpResponseMessage})"> <summary> Handles the request. </summary> <param name="httpRequestMessage">The HTTP request message.</param> <param name="successAction">The success action.</param> <param name="errorAction">The error action.</param> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.ProcessRecord"> <summary> Processes the record. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetIdUri(System.String)"> <summary> Gets the identifier URI. </summary> <param name="id">The identifier.</param> <returns>The identifier URI.</returns> </member> <member name="M:MicrosoftPlaces.PlacesDevicesPSCmdlet.GetErrorRecord(System.Net.Http.HttpResponseMessage)"> <summary> Gets the error record. </summary> <param name="response">The response.</param> <returns>The error record.></returns> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.DeviceId"> <summary> Gets or sets the user provided device identifier. </summary> <value> The device identifier of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.DisplayName"> <summary> Gets or sets the display name of the device. </summary> <value> The display name of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.Description"> <summary> Gets or sets the description of the device. </summary> <value> The description of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.MACAddress"> <summary> Gets or sets the mac address of the device. </summary> <value> The mac address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.Manufacturer"> <summary> Gets or sets the manufacturer. </summary> <value> The manufacturer of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.IPV4Address"> <summary> Gets or sets the ip v4 address. </summary> <value> The ip v4 address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.IPV6Address"> <summary> Gets or sets the ip v6 address of the device. </summary> <value> The ip v6 address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.PlaceId"> <summary> Gets or sets the place identifier of the device. </summary> <value> The place identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.Tags"> <summary> Gets or sets the tags of the device. </summary> <value> The tags of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.Sensors"> <summary> Gets or sets the sensors of the device. </summary> <value> The sensors of the device. </value> </member> <member name="M:MicrosoftPlaces.PlacesDevices.CreatePlaceDevice.ExecuteCmdlet"> <summary> Executes the cmdlet by creating a new device object. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevices.DeletePlaceDevice.Id"> <summary> Gets or sets the identifier. </summary> <value> The identifier. </value> </member> <member name="M:MicrosoftPlaces.PlacesDevices.DeletePlaceDevice.ExecuteCmdlet"> <summary> Executes the cmdlet to delete a device. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDevices.FindPlaceDevices.FindResponseValueField"> <summary> The find response value field </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevices.FindPlaceDevices.Filter"> <summary> Gets or sets the filter. </summary> <value> The filter. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.FindPlaceDevices.Top"> <summary> Gets or sets the top. </summary> <value> The top. </value> </member> <member name="M:MicrosoftPlaces.PlacesDevices.FindPlaceDevices.ExecuteCmdlet"> <summary> Executes the cmdlet. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDevices.FindPlaceDevices.GetListUri"> <summary> Gets the list URI. </summary> <returns>The URI.</returns> </member> <member name="P:MicrosoftPlaces.PlacesDevices.GetPlaceDevice.Id"> <summary> Gets or sets the identifier. </summary> <value> The identifier. </value> </member> <member name="M:MicrosoftPlaces.PlacesDevices.GetPlaceDevice.ExecuteCmdlet"> <summary> Executes the cmdlet. </summary> </member> <member name="T:MicrosoftPlaces.PlacesDevices.Device"> <summary> Device data model. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.Id"> <summary> Gets or sets the identifier. </summary> <value> The identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.DeviceId"> <summary> Gets or sets the device identifier. </summary> <value> The device identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.DisplayName"> <summary> Gets or sets the display name. </summary> <value> The display name. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.Description"> <summary> Gets or sets the description. </summary> <value> The description. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.MACAddress"> <summary> Gets or sets the mac address. </summary> <value> The mac address. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.Manufacturer"> <summary> Gets or sets the manufacturer. </summary> <value> The manufacturer. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.IPV4Address"> <summary> Gets or sets the ip v4 address. </summary> <value> The ip v4 address. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.IPV6Address"> <summary> Gets or sets the ip v6 address. </summary> <value> The ip v6 address. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.PlaceId"> <summary> Gets or sets the place identifier. </summary> <value> The place identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.Tags"> <summary> Gets or sets the tags. </summary> <value> The tags. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Device.Sensors"> <summary> Gets or sets the sensors. </summary> <value> The sensors. </value> </member> <member name="T:MicrosoftPlaces.PlacesDevices.Sensor"> <summary> Sensor data model. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Sensor.SensorId"> <summary> Gets or sets the sensor identifier. </summary> <value> The sensor identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Sensor.DisplayName"> <summary> Gets or sets the display name. </summary> <value> The display name. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Sensor.SensorType"> <summary> Gets or sets the type of the sensor. </summary> <value> The type of the sensor. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.Sensor.PlaceId"> <summary> Gets or sets the place identifier. </summary> <value> The place identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.Id"> <summary> Gets or sets the identifier. </summary> <value> The identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.DeviceId"> <summary> Gets or sets the user provided device identifier. </summary> <value> The device identifier of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.DisplayName"> <summary> Gets or sets the display name of the device. </summary> <value> The display name of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.Description"> <summary> Gets or sets the description of the device. </summary> <value> The description of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.MACAddress"> <summary> Gets or sets the mac address of the device. </summary> <value> The mac address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.Manufacturer"> <summary> Gets or sets the manufacturer. </summary> <value> The manufacturer of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.IPV4Address"> <summary> Gets or sets the ip v4 address. </summary> <value> The ip v4 address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.IPV6Address"> <summary> Gets or sets the ip v6 address of the device. </summary> <value> The ip v6 address of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.PlaceId"> <summary> Gets or sets the place identifier of the device. </summary> <value> The place identifier. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.Tags"> <summary> Gets or sets the tags of the device. </summary> <value> The tags of the device. </value> </member> <member name="P:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.Sensors"> <summary> Gets or sets the sensors of the device. </summary> <value> The sensors of the device. </value> </member> <member name="M:MicrosoftPlaces.PlacesDevices.UpdatePlaceDevice.ExecuteCmdlet"> <summary> Update the deviceSensor metadata. Parses the data and use deviceInventoryService API to update the deviceSensor metadata. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.PostOfficeBox"> <summary> Post office box info. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.PostalCode"> <summary> Zipcode. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.CountryOrRegion"> <summary> CountryOrRegion. CountryOrRegion must be a valid ISO code. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.State"> <summary> State. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.City"> <summary> City name. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.CreatePlace.Street"> <summary> Street address. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.MaxLatitude"> <summary>Maximum valid latitude</summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.MinLatitude"> <summary>Minimum valid latitude</summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.MaxLongitude"> <summary>Maximum valid longitude</summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.MinLongitude"> <summary>Minimum valid longitude</summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/> class. </summary> <param name="expression">The string representation of the GeoCoordinates</param> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.#ctor(System.Double,System.Double)"> <summary> Initializes a new instance of the <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/> class. </summary> <param name="latitude">Latitude (in degrees)</param> <param name="longitude">Longitude (in degrees)</param> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.#ctor(System.Double,System.Double,System.Double)"> <summary> Initializes a new instance of the <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/> class. </summary> <param name="latitude">Latitude (in degrees)</param> <param name="longitude">Longitude (in degrees)</param> <param name="altitude">Altitude (in meters)</param> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.Latitude"> <summary> Latitude (in degrees) </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.Longitude"> <summary> Longitude (in degrees) </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.Altitude"> <summary> Altitude (in meters) </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.ToString"> <summary> Displays the string representation of the <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/> </summary> <returns>The string representation of the <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/></returns> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.IsValidLatitude(System.Double)"> <summary> Verifies if the specified value is a valid latitude </summary> <param name="latitude">The value to be verified</param> <returns>True if the value is a valid latitude, otherwise false</returns> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.IsValidLongitude(System.Double)"> <summary> Verifies if the specified value is a valid longitude </summary> <param name="longitude">The value to be verified</param> <returns>True if the value is a valid longitude, otherwise false</returns> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.GeoCoordinates.ParseAndValidateGeoCoordinates(System.String)"> <summary> Parse and validate the specified string into <see cref="T:MicrosoftPlaces.PlacesDirectory.GeoCoordinates"/> </summary> <param name="geoCoordinates">The geocoordinates in string format</param> </member> <member name="T:MicrosoftPlaces.PlacesDirectory.InitializePlaces"> <summary> Cmdlet who has the capacity to onboard locations to Places App. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.InitializePlaces.HybridTenant"> <summary> This switch parameters can be passed by user to indicate they are a hybrid tenant. When the parameter is passed, the process won't update the rooms and spaces properties not allowed to be updated by Set-Place cmdlet. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.InitializePlaces.ExportLocationHierarchy"> <summary> This step get the existing locations and exports it to a csv file. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.InitializePlaces.OnboardLocations"> <summary> This step read the csv content and creates/updates places. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Identity"> <summary> The id. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Name"> <summary> Name of the place. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Type"> <summary> Type of the place. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Description"> <summary> Description of the place. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.PostOfficeBox"> <summary> Post office box info. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.PostalCode"> <summary> Zipcode. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.CountryOrRegion"> <summary> CountryOrRegion. CountryOrRegion must be a valid ISO code. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.State"> <summary> State. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.City"> <summary> City name. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.Street"> <summary> Street address. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.ParentId"> <summary> id of the parent place that the place belongs to. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.ParentName"> <summary> id of the parent place that the place belongs to. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.PlaceDirectoryPresentationObject.IsPlaceFromV3(System.String)"> <summary> We distinguish V1 and V3 places on the type of Identity. V3 places have a Guid as identifier. V1 places have SMTP address or alias. </summary> <returns></returns> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.PostOfficeBox"> <summary> Post office box info. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.PostalCode"> <summary> Zipcode. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.CountryOrRegion"> <summary> CountryOrRegion. CountryOrRegion must be a valid ISO code. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.State"> <summary> State. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.City"> <summary> City name. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.UpdatePlace.Street"> <summary> Street address. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.UpdatePlace.ValidateV1Parameters"> <summary> Check parameters provided by user and shows a warning message in case some of it is not compatible with a V1 Place. </summary> </member> <member name="M:MicrosoftPlaces.PlacesDirectory.UpdatePlace.ValidateV3Parameters"> <summary> Check parameters provided by user and shows a warning message in case some of it is not compatible with a V3 Place. </summary> </member> <member name="T:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1"> <summary> The type of place in v1. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.Unknown"> <summary> Unknown place type </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.Room"> <summary> Place type for conference rooms </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.RoomList"> <summary> Place type for room lists </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.Place"> <summary> Place type for a place such as an address or a business. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.Space"> <summary> Place type for Spaces </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.PlaceTypeV1.Desk"> <summary> Place type for Desks </summary> </member> <member name="T:MicrosoftPlaces.PlacesDirectory.ParentLocationType"> <summary> Enum to determine what is the parent type for a resource. </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.ParentLocationType.None"> <summary> Not specified </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.ParentLocationType.Section"> <summary> Section is the parent </summary> </member> <member name="F:MicrosoftPlaces.PlacesDirectory.ParentLocationType.Floor"> <summary> Floor is the parent </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Identity"> <summary> The email address. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.DisplayName"> <summary> Place Display Name. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Type"> <summary> Place Type. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Street"> <summary> Street of Place Address </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.City"> <summary> City of Place Address </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.State"> <summary> State of Place address </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.PostalCode"> <summary> Postal Code. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.GeoCoordinates"> <summary> The GeoCoordinates. </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Capacity"> <summary> The Capacity </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Building"> <summary> The building </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.ParentType"> <summary> The type of this Location's Parent </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.CampusId"> <summary> ID of the Campus node in the Location Hierarchy </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.BuildingId"> <summary> ID of the Building node in the Location Hierarchy </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.FloorId"> <summary> ID of the Floor node in the Location Hierarchy </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.SectionId"> <summary> ID of the Section node in the Location Hierarchy </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Label"> <summary> The place label </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.MTREnabled"> <summary> MTREnabled </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.AudioDeviceName"> <summary> The AudioDeviceName </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.VideoDeviceName"> <summary> The VideoDeviceName </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.DisplayDeviceName"> <summary> The DisplayDeviceName </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Phone"> <summary> The phone number </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Floor"> <summary> The Floor </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.FloorLabel"> <summary> The floor label </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.Localities"> <summary> Place Capabilities </summary> </member> <member name="P:MicrosoftPlaces.PlacesDirectory.PlacePresentationObject.RoomListNames"> <summary> Place Capabilities </summary> </member> <member name="F:MicrosoftPlaces.PlacesMaps.ImportMapCorrelations.FeaturesToExport"> <summary> Map feature types that can be correlatable to objects in Places Directory. </summary> </member> <member name="F:MicrosoftPlaces.PlacesMaps.ImportMapCorrelations.CategoriesToExclude"> <summary> Known feature categories that won't be correlated to anything in Directory and should be ignored when creating a list of features to correlate. </summary> </member> <member name="P:MicrosoftPlaces.PlacesMaps.Models.ImdfFeature.DirectoryId"> <inheritdoc/> </member> <member name="P:MicrosoftPlaces.PlacesMaps.Models.ImdfFeature.DirectoryLevelId"> <inheritdoc/> </member> <member name="P:MicrosoftPlaces.PlacesMaps.Models.ImdfFeature.MapLevelId"> <inheritdoc/> </member> <member name="P:MicrosoftPlaces.PlacesMaps.Models.ImdfFeature.DirectoryBuildingId"> <inheritdoc/> </member> <member name="P:MicrosoftPlaces.PlacesMaps.Models.ImdfFeature.MapBuildingId"> <inheritdoc/> </member> <member name="P:MicrosoftPlaces.PlacesMaps.Models.ImdfFeature.LocalizedName"> <inheritdoc/> </member> <member name="P:MicrosoftPlaces.PlacesMaps.Models.ImdfFeature.Name"> <inheritdoc/> </member> <member name="P:MicrosoftPlaces.PlacesMaps.Models.ImdfFeature.Category"> <inheritdoc/> </member> <member name="P:MicrosoftPlaces.PlacesMaps.Models.ImdfFeature.Ordinal"> <inheritdoc/> </member> <member name="P:MicrosoftPlaces.PlacesMaps.Models.ImdfFeature.SmtpAddress"> <inheritdoc/> </member> <member name="M:MicrosoftPlaces.PlacesMaps.Models.ImdfFeatureCollection.#ctor"> <summary> Initializes a new instance of the ImportMapFeatureCollection class. </summary> </member> <member name="M:MicrosoftPlaces.PlacesMaps.Models.ImdfFeatureCollection.#ctor(System.Collections.Generic.List{MicrosoftPlaces.PlacesMaps.Models.ImdfFeature})"> <summary> Initializes a new instance of the <see cref="T:MicrosoftPlaces.PlacesMaps.Models.ImdfFeatureCollection" /> class. </summary> <param name="features">The features.</param> </member> <member name="T:MicrosoftPlaces.PlacesMaps.Models.ImdfFeatureProperties"> <summary> Properties of map features specific to the IMDF feature format </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettingsPSCmdlet.IsDev"> <summary> Dev switch to enable local dev execution. Mostly used for Visual Studio launching. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.GetPlacesSettings.Collection"> <summary> Gets or sets a value indicating which collection to get the settings from. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.GetPlacesSettings.ReadFromPrimary"> <summary> If enabled, get the settings data from primary source instead of from cache. </summary> </member> <member name="M:MicrosoftPlaces.PlacesSettings.GetPlacesSettings.ExecuteCmdlet"> <summary> Gets all the settings for the tenant. </summary> </member> <member name="F:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.properties"> <summary> This dictionary field contains all the valid parameters for properties that can be set on the Places settings. These parameters are specified in the properties below, which are taken from the command line by their names defined on Constants.cs. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.Collection"> <summary> Gets or sets a value indicating which collection to set the settings from. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.AllowInConnectionsList"> <summary> AllowInConnectionsList parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.PlacesEnabled"> <summary> PlacesEnabled parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.SpaceAnalyticsEnabled"> <summary> SpaceAnalyticsEnabled parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.PeopleDirectoryLocationFormat"> <summary> PeopleDirectoryLocationFormat parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.WifiSignalLocationFormat"> <summary> WifiSignalLocationFormat parameter. </summary> </member> <member name="P:MicrosoftPlaces.PlacesSettings.SetPlacesSettings.BadgeSwipeLocationFormat"> <summary> BadgeSwipeLocationFormat parameter. </summary> </member> <member name="M:MicrosoftPlaces.PlacesSettings.SettingsConverters.ValidateSettingsPrefix(System.String)"> <summary> Validate and return the same settings prefix if it is valid. </summary> <param name="settingsPrefix">The settings prefix to validate.</param> <returns>The prefix, if it is valid.</returns> <exception cref="T:System.ArgumentException">If the settings prefix is not valid.</exception> </member> <member name="M:MicrosoftPlaces.PlacesSettings.SettingsConverters.ValidateProperties(System.Collections.Generic.IDictionary{System.String,System.String},System.String)"> <summary> Validate and convert the parameters passed to a Update cmdlet. </summary> <param name="parameters">The values passed as a dictionary, with the parameter name as key and scoped values as value in string format.</param> <param name="settingsPrefix">The settings namespace to validate and convert the values.</param> <returns>A dictionary with the parameter full name as key and scoped values as value.</returns> <exception cref="T:System.ArgumentException">If there are no parameters or one of the keys or values is invalid.</exception> </member> <member name="M:MicrosoftPlaces.PlacesSettings.SettingsConverters.ParseToScopedValues(System.String,System.String)"> <summary> Receives a scoped value in string format and convert it to a ScopedValue object. </summary> <param name="scopedId">A valid scope id.</param> <param name="scopedValues">A scope value in string format.</param> <returns>A ScopedValue object.</returns> <exception cref="T:System.ArgumentException">If the value is invalid, due to have an invalid format or an invalid scopeId.</exception> </member> <member name="M:MicrosoftPlaces.PlacesSettings.SettingsConverters.ValidateScopeId(System.String)"> <summary> Receives a scopeId in string format and validate it. </summary> <param name="scopeId">A scopeId in string format.</param> <returns>The same scopeId passed.</returns> <exception cref="T:System.ArgumentException">If the scopeId is not "Default" and not in the format "OID:[OID]@[TID]".</exception> </member> </members> </doc> |