Get-AzCommunicationService

Reference

Module:: Az.Communication

Get the CommunicationService and its properties.

Syntax

Get-AzCommunicationService
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzCommunicationService
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzCommunicationService
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzCommunicationService
   -InputObject <ICommunicationIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get the CommunicationService and its properties.

Examples

Example 1: List existing CommunicationServices for a Subscription

Get-AzCommunicationService -SubscriptionId 632ec9eb-fad7-4cbd-993a-e72973ba2acc

Location Name                SystemDataCreatedAt  SystemDataCreatedBy         SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy   SystemDataLastModifiedByType
-------- ----                -------------------  -------------------         ----------------------- ------------------------ ------------------------   ----------------------------
Global   ContosoAcsResource1 7/09/2024 4:41:40 AM contosouser@microsoft.com   User                    7/09/2024 4:41:40 AM     contosouser@microsoft.com  User
Global   ContosoAcsResource2 4/10/2024 2:41:40 AM contosouser2@microsoft.com  User                    4/10/2024 2:41:40 AM     contosouser2@microsoft.com User
Global   ContosoAcsResource3 5/01/2024 1:41:40 AM contosouser3@microsoft.com  User                    5/01/2024 1:41:40 AM     contosouser3@microsoft.com User
Global   ContosoAcsResource4 6/08/2024 5:41:40 AM contosouser4@microsoft.com  User                    6/08/2024 5:41:40 AM     contosouser4@microsoft.com User
Global   ContosoAcsResource5 6/09/2024 4:41:40 AM contosouser5@microsoft.com  User                    6/09/2024 4:41:40 AM     contosouser5@microsoft.com User

Returns a list of all ACS resources under that subscription.

Example 2: Get infomation on specified Azure Communication resource

Get-AzCommunicationService -Name ContosoAcsResource34 -ResourceGroupName ContosoResourceProvider1

Location Name                SystemDataCreatedAt  SystemDataCreatedBy        SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy  SystemDataLastModifiedByType
-------- ----                -------------------  -------------------        ----------------------- ------------------------ ------------------------  ----------------------------
Global   ContosoAcsResource1 7/10/2024 4:41:40 AM contosouser@microsoft.com  User                    7/10/2024 9:02:15 AM     contosouser@microsoft.com User

Returns the information on an ACS resource, if one matching provided parameters is found.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	ICommunicationIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the CommunicationService resource.

Type:	String
Aliases:	CommunicationServiceName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

ICommunicationIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceResource

Share via