Get-AzSupportTicketCommunication
Get support ticket communications.
Syntax
Get-AzSupportTicketCommunication
-SupportTicketName <String>
[-Name <String>]
[-Filter <String>]
[-DefaultProfile <IAzureContextContainer>]
[-IncludeTotalCount]
[-Skip <UInt64>]
[-First <UInt64>]
[<CommonParameters>] Get-AzSupportTicketCommunication
[-Name <String>]
-SupportTicketObject <PSSupportTicket>
[-Filter <String>]
[-DefaultProfile <IAzureContextContainer>]
[-IncludeTotalCount]
[-Skip <UInt64>]
[-First <UInt64>]
[<CommonParameters>] Description
Gets communications for a support ticket. It will retrieve all the communications for a ticket if you do not specify any other parameters. You can also filter the communications by CreatedDate or CommunicationType using the Filter parameter. Here are some examples of filter values that you can specify.
| Scenario | Filter |
|---|---|
| Get Web communications | "CommunicationType eq 'Web'" |
| Get Phone communications | "CommunicationType eq 'Phone'" |
| Get communications that were created on or after 20th Dec, 2019 | "CreatedDate ge 2019-12-20" |
| Get communications that were created after 20th Dec, 2019 | "CreatedDate gt 2019-12-20" |
| Gets Web communications created after 20th Dec, 2019 | "CreatedDate gt 2019-12-20 and CommunicationType eq 'Web'" |
This cmdlet supports paging via First and Skip parameters.
You can also retrieve a single support ticket communication by specifying the communication name.
Examples
Example 1: Retrieve all communications for a support ticket
Get-AzSupportTicketCommunication -SupportTicketName "test1"
Name Sender Subject CreatedDate
---- ------ ------- -----------
testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM
testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PM
testmessage1 user@contoso.com test message 2/4/2020 9:35:42 PMExample 2: Retrieve a single communication by it's name for a support ticket
Get-AzSupportTicketCommunication -SupportTicketName "test1" -Name "testmessage1"
Name Sender Subject CreatedDate
---- ------ ------- -----------
testmessage1 user@contoso.com test message 2/4/2020 9:38:14 PMExample 3: Retrieve first 2 communications for a support ticket
Get-AzSupportTicketCommunication -SupportTicketName "test1" -First 2
Name Sender Subject CreatedDate
---- ------ ------- -----------
testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM
testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PMExample 4: Retrieve next 2 communications after skipping first 2 communications for a support ticket
Get-AzSupportTicketCommunication -SupportTicketName "test1" -Skip 2 -First 2
Name Sender Subject CreatedDate
---- ------ ------- -----------
testmessage4 user@contoso.com test message4 2/4/2020 9:38:14 PM
testmessage5 user@contoso.com test message5 2/4/2020 9:36:36 PMExample 5: Retrieve all Web communications for a support ticket
Get-AzSupportTicketCommunication -SupportTicketName "test1" -Filter "CommunicationType eq 'Web'"
Name Sender Subject CreatedDate
---- ------ ------- -----------
testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM
testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PMExample 6: Retrieve all communications created on or after Dec 20th, 2019 for a support ticket
Get-AzSupportTicketCommunication -SupportTicketName "test1" -Filter "CreatedDate ge 2019-12-20"
Name Sender Subject CreatedDate
---- ------ ------- -----------
testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM
testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PMExample 7: Retrieve all Web communications created on or after Dec 20th, 2019 for a support ticket
Get-AzSupportTicketCommunication -SupportTicketName "test1" -Filter "CommunicationType eq 'Web' and CreatedDate ge 2019-12-20"
Name Sender Subject CreatedDate
---- ------ ------- -----------
testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM
testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PMExample 8: Retrieve all communications for a support ticket by piping support ticket object
Get-AzSupportTicket -Name "test1" | Get-AzSupportTicketCommunication
Name Sender Subject CreatedDate
---- ------ ------- -----------
testmessage3 user@contoso.com test message3 2/4/2020 9:38:14 PM
testmessage2 user@contoso.com test message2 2/4/2020 9:36:36 PM
testmessage1 user@contoso.com test message 2/4/2020 9:35:42 PMParameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Filter to be applied to the results of this cmdlet.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-First
Gets only the specified number of objects. Enter the number of objects to get.
| Type: | UInt64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludeTotalCount
Reports the total number of objects in the data set (an integer) followed by the selected objects. If the cmdlet cannot determine the total count, it displays "Unknown total count." The integer has an Accuracy property that indicates the reliability of the total count value. The value of Accuracy ranges from 0.0 to 1.0 where 0.0 means that the cmdlet could not count the objects, 1.0 means that the count is exact, and a value between 0.0 and 1.0 indicates an increasingly reliable estimate.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Communication name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Ignores the specified number of objects and then gets the remaining objects. Enter the number of objects to skip.
| Type: | UInt64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SupportTicketName
Support ticket name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SupportTicketObject
Support ticket object.
| Type: | PSSupportTicket |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |