en-US/O365ServiceCommunications-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-O365ServiceCommunications</command:name> <command:verb>Connect</command:verb> <command:noun>O365ServiceCommunications</command:noun> <maml:description> <maml:para>Initiates a connection to the Office 365 Service Communications API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Initiates a connection to the Office 365 Service Communications API. This connection is required before you can run any other commands in this module. In order to establish a connection you must first register an application in Azure Active Directory with the appropriate permissions. See the 'Related Links' section for a walkthrough of how to register this application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-O365ServiceCommunications</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ClientID</maml:name> <maml:Description> <maml:para>The client ID of the Azure Active Directory registered application. See the 'Related Links' section for a walkthrough of how to register this application.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ClientSecret</maml:name> <maml:Description> <maml:para>The client secret of the Azure Active Directory registered application. See the 'Related Links' section for a walkthrough of how to register this application.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>TenantID</maml:name> <maml:Description> <maml:para>Your Office 365 tenant ID. This can also be found in the properties of your registered application.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ClientID</maml:name> <maml:Description> <maml:para>The client ID of the Azure Active Directory registered application. See the 'Related Links' section for a walkthrough of how to register this application.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ClientSecret</maml:name> <maml:Description> <maml:para>The client secret of the Azure Active Directory registered application. See the 'Related Links' section for a walkthrough of how to register this application.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>TenantID</maml:name> <maml:Description> <maml:para>Your Office 365 tenant ID. This can also be found in the properties of your registered application.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $ClientID = "10da3cc3-4a37-4e1e-9c75-8f894bfe8c34" PS C:\> $ClientSecret = "n6RB_(A4[5SMQk2@7Z20LQAKrE/IlCyD" PS C:\> $TenantID = "41f8c530-0c2a-466c-98cf-dbadbfca090c" PS C:\> Connect-O365ServiceCommunications -ClientID $ClientID -ClientSecret $ClientSecret -TenantID $TenantID</dev:code> <dev:remarks> <maml:para>This example demonstrates connecting to the Office 365 Service Communications API using your tenant ID, along with the client ID and secret created for your registered application.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://docs.microsoft.com/en-us/office/office-365-management-api/get-started-with-office-365-management-apis</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/office/office-365-management-api/get-started-with-office-365-management-apis</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SCMessage</command:name> <command:verb>Get</command:verb> <command:noun>SCMessage</command:noun> <maml:description> <maml:para>Retrieves service messages from the Office 365 Service Communications API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves service messages from the Office 365 Service Communications API. These are typically messages relating to new features, maintenance, and service health incidents.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SCMessage</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>End</maml:name> <maml:Description> <maml:para>The -End parameter specifies the end of a given date/time range for which to retrieve messages.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Now</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MessageType</maml:name> <maml:Description> <maml:para>Specifies the type of messages to filter for. These are typically MessageCenter or Incident, but other types may be possible. Please be aware that this parameter's value is case-sensitive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Start</maml:name> <maml:Description> <maml:para>The -Start parameter specifies the starting date/time for which to retrieve messages.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>7 days ago</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Workload</maml:name> <maml:Description> <maml:para>Specifies the service for which to return messages. The names of available services can be retrieved using the Get-Service command. Please be aware that this parameter's value is case-sensitive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SCMessage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the Id of a particular message to retrieve. -Id cannot be used with any other parameters, and it's value is case-sensitive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>End</maml:name> <maml:Description> <maml:para>The -End parameter specifies the end of a given date/time range for which to retrieve messages.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Now</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the Id of a particular message to retrieve. -Id cannot be used with any other parameters, and it's value is case-sensitive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MessageType</maml:name> <maml:Description> <maml:para>Specifies the type of messages to filter for. These are typically MessageCenter or Incident, but other types may be possible. Please be aware that this parameter's value is case-sensitive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Start</maml:name> <maml:Description> <maml:para>The -Start parameter specifies the starting date/time for which to retrieve messages.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>7 days ago</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Workload</maml:name> <maml:Description> <maml:para>Specifies the service for which to return messages. The names of available services can be retrieved using the Get-Service command. Please be aware that this parameter's value is case-sensitive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>O365ServiceCommunications_Message</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SCMessage</dev:code> <dev:remarks> <maml:para>This example retrieves all active messages for your tenant.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-SCMessage -Id EX50699</dev:code> <dev:remarks> <maml:para>This example will retrieve a particular message by its Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-SCMessage -Workload Sharepoint</dev:code> <dev:remarks> <maml:para>This example retrieves all messages for a particular Workload - Sharepoint in this case.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-SCMessage -Start 2/1/2020 -End 4/1/2020</dev:code> <dev:remarks> <maml:para>This example retrieves any messages within a given date range.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-service-communications-api-reference#get-messages</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-service-communications-api-reference#get-messages</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SCService</command:name> <command:verb>Get</command:verb> <command:noun>SCService</command:noun> <maml:description> <maml:para>Retrieves available services from your tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves available services from your tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SCService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>O365ServiceCommunications_Service</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SCService</dev:code> <dev:remarks> <maml:para>This example retrieves all the available services from your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-service-communications-api-reference#get-services</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-service-communications-api-reference#get-services</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SCStatus</command:name> <command:verb>Get</command:verb> <command:noun>SCStatus</command:noun> <maml:description> <maml:para>Retrieves information regarding the current or historical status of Office 365 services.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves information regarding the current or historical status of Office 365 services. This information can be filtered by a given workload.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SCStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Specifies the earliest date for which to retrieve historical status information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Workload</maml:name> <maml:Description> <maml:para>The Office 365 service for which you'd like to retrieve information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:Description> <maml:para>Specifies the earliest date for which to retrieve historical status information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Workload</maml:name> <maml:Description> <maml:para>The Office 365 service for which you'd like to retrieve information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>O365ServiceCommunications_Status</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SCStatus</dev:code> <dev:remarks> <maml:para>This example retrieves the current status of all Office 365 workloads.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-SCStatus -Workload Exchange</dev:code> <dev:remarks> <maml:para>This example retrieves the current status for a particular Office 365 workload.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-SCStatus -Workload Exchange -From 1/1/2020</dev:code> <dev:remarks> <maml:para>This example retrieves the historical status for a particular Office 365 workload.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-service-communications-api-reference#get-current-status</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-service-communications-api-reference#get-current-status</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-service-communications-api-reference#get-historical-status</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-service-communications-api-reference#get-historical-status</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |