Get-AzCommunicationService

Module:

Az.Communication Module

Get the CommunicationService and its properties.

Syntax

List (Default)

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

Get

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

List1

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

GetViaIdentity

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.

Parameter properties

Type:	PSObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter

Parameter properties

Type:	ICommunicationIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

The name of the CommunicationService resource.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	CommunicationServiceName

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

List1

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubscriptionId

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

Parameter properties

Type:	String[]
Default value:	(Get-AzContext).Subscription.Id
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

List1

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

ICommunicationIdentity

Outputs

ICommunicationServiceResource