diff --git a/.openpublishing.redirection.skype.json b/.openpublishing.redirection.skype.json index c034ac18a3..b36ea96b4e 100644 --- a/.openpublishing.redirection.skype.json +++ b/.openpublishing.redirection.skype.json @@ -2,1817 +2,1817 @@ "redirections": [ { "source_path": "skype/virtual-folder/skype/Disable-CsOnlineSipDomain.md", - "redirect_url": "/powershell/module/teams/Disable-CsOnlineSipDomain", + "redirect_url": "/powershell/module/MicrosoftTeams/Disable-CsOnlineSipDomain", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Enable-CsOnlineSipDomain.md", - "redirect_url": "/powershell/module/teams/Enable-CsOnlineSipDomain", + "redirect_url": "/powershell/module/MicrosoftTeams/Enable-CsOnlineSipDomain", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Export-CsAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/Export-CsAutoAttendantHolidays", + "redirect_url": "/powershell/module/MicrosoftTeams/Export-CsAutoAttendantHolidays", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/export-csonlineaudiofile.md", - "redirect_url": "/powershell/module/teams/export-csonlineaudiofile", + "redirect_url": "/powershell/module/MicrosoftTeams/export-csonlineaudiofile", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Find-CsGroup.md", - "redirect_url": "/powershell/module/teams/Find-CsGroup", + "redirect_url": "/powershell/module/MicrosoftTeams/Find-CsGroup", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Find-CsOnlineApplicationInstance.md", - "redirect_url": "/powershell/module/teams/Find-CsOnlineApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/Find-CsOnlineApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsApplicationAccessPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsApplicationAccessPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsApplicationMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsApplicationMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsApplicationMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendant.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendant", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantHolidays", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantHolidays", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantStatus.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantStatus", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantStatus", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantSupportedLanguage.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantSupportedLanguage", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantSupportedTimeZone.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantSupportedTimeZone", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantTenantInformation.md", - "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantTenantInformation", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsAutoAttendantTenantInformation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsCallingLineIdentity.md", - "redirect_url": "/powershell/module/teams/Get-CsCallingLineIdentity", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsCallingLineIdentity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsCallQueue.md", - "redirect_url": "/powershell/module/teams/Get-CsCallQueue", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsCallQueue", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsEffectiveTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Get-CsEffectiveTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsEffectiveTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsInboundBlockedNumberPattern.md", - "redirect_url": "/powershell/module/teams/Get-CsInboundBlockedNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsInboundBlockedNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsInboundExemptNumberPattern.md", - "redirect_url": "/powershell/module/teams/Get-CsInboundExemptNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsInboundExemptNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsMeetingMigrationStatus.md", - "redirect_url": "/powershell/module/teams/Get-CsMeetingMigrationStatus", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsMeetingMigrationStatus", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstance.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstanceAssociation.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstanceAssociation", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstanceAssociationStatus.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstanceAssociationStatus", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineAudioFile.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineAudioFile", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineAudioFile", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingBridge.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingBridge", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingLanguagesSupported", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialinConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialinConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingServiceNumber.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingServiceNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialinConferencingTenantConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingTenantSettings.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingTenantSettings", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUser.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingUser", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialInConferencingUser", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialOutPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDialOutPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDialOutPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDirectoryTenant.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineDirectoryTenant", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineDirectoryTenant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisCivicAddress.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisCivicAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisCivicAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisLocation.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisLocation", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisLocation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisPort.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisPort", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisPort", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisSubnet.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisSwitch.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisSwitch", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisSwitch", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisWirelessAccessPoint.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineLisWirelessAccessPoint", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlinePSTNGateway.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlinePSTNGateway", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlinePSTNGateway", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlinePstnUsage.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlinePstnUsage", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlinePstnUsage", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineSchedule.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineSchedule", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineSchedule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineSipDomain.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineSipDomain", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineSipDomain", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumber.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineTelephoneNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineTelephoneNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineUser.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineUser", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineUser", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoicemailPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineVoicemailPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoicemailPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoicemailUserSettings.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineVoicemailUserSettings", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceRoute.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceRoute", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoiceRoute", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceUser.md", - "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceUser", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsOnlineVoiceUser", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsAppPermissionPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsAppPermissionPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsAppSetupPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsAppSetupPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsAppSetupPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsAudioConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsAudioConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallHoldPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsCallHoldPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCallHoldPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallParkPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsCallParkPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCallParkPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsChannelsPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsChannelsPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsChannelsPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsClientConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsClientConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsClientConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsComplianceRecordingApplication.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsComplianceRecordingApplication", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsComplianceRecordingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsComplianceRecordingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsComplianceRecordingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsCortanaPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsCortanaPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsCortanaPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsEducationAssignmentsAppPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsEducationAssignmentsAppPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsEmergencyCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsEmergencyCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsEmergencyCallRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsEmergencyCallRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsFeedbackPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsFeedbackPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsFeedbackPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestCallingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestCallingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestMessagingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestMessagingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsIPPhonePolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsIPPhonePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsIPPhonePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBrandingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBrandingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBroadcastConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBroadcastConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBroadcastPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBroadcastPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMessagingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMessagingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMessagingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsMobilityPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsMobilityPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsMobilityPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsNetworkRoamingPolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsNetworkRoamingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsTranslationRule.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsTranslationRule", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsTranslationRule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsVideoInteropServicePolicy.md", - "redirect_url": "/powershell/module/teams/Get-CsTeamsVideoInteropServicePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenant.md", - "redirect_url": "/powershell/module/teams/Get-CsTenant", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantBlockedCallingNumbers.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantBlockedCallingNumbers", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantFederationConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantFederationConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantFederationConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantLicensingConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantLicensingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantLicensingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantMigrationConfiguration.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantMigrationConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantMigrationConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkRegion.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkRegion", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantNetworkRegion", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkSite.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkSite", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantNetworkSite", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkSubnet.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantNetworkSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantTrustedIPAddress.md", - "redirect_url": "/powershell/module/teams/Get-CsTenantTrustedIPAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsTenantTrustedIPAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsVideoInteropServiceProvider.md", - "redirect_url": "/powershell/module/teams/Get-CsVideoInteropServiceProvider", + "redirect_url": "/powershell/module/MicrosoftTeams/Get-CsVideoInteropServiceProvider", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsApplicationAccessPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsApplicationAccessPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsCallingLineIdentity.md", - "redirect_url": "/powershell/module/teams/Grant-CsCallingLineIdentity", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsCallingLineIdentity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsCloudMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsCloudMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsCloudMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsDialoutPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsDialoutPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsDialoutPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsExternalUserCommunicationPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsExternalUserCommunicationPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsExternalUserCommunicationPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsOnlineVoicemailPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsOnlineVoicemailPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsOnlineVoiceRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsOnlineVoiceRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAppPermissionPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsAppPermissionPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsAppPermissionPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAppSetupPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsAppSetupPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAudioConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsAudioConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallHoldPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallHoldPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallParkPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallParkPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCallParkPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsChannelsPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsChannelsPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsChannelsPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsComplianceRecordingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsComplianceRecordingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCortanaPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsCortanaPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsCortanaPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsEmergencyCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsEmergencyCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsEmergencyCallRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsEmergencyCallRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsFeedbackPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsFeedbackPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsIPPhonePolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsIPPhonePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingBrandingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingBrandingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingBroadcastPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingBroadcastPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMessagingPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsMessagingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMessagingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMobilityPolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsMobilityPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsMobilityPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTeamsVideoInteropServicePolicy.md", - "redirect_url": "/powershell/module/teams/Grant-CsTeamsVideoInteropServicePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Grant-CsTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Grant-CsTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Import-CsAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/Import-CsAutoAttendantHolidays", + "redirect_url": "/powershell/module/MicrosoftTeams/Import-CsAutoAttendantHolidays", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Import-CsOnlineAudioFile.md", - "redirect_url": "/powershell/module/teams/Import-CsOnlineAudioFile", + "redirect_url": "/powershell/module/MicrosoftTeams/Import-CsOnlineAudioFile", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsApplicationAccessPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsApplicationAccessPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendant.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendant", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallableEntity.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallableEntity", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantCallableEntity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallFlow.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallFlow", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantCallFlow", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallHandlingAssociation.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallHandlingAssociation", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantDialScope.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantDialScope", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantDialScope", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantMenu.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantMenu", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantMenu", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantMenuOption.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantMenuOption", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantMenuOption", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantPrompt.md", - "redirect_url": "/powershell/module/teams/New-CsAutoAttendantPrompt", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsAutoAttendantPrompt", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsCallingLineIdentity.md", - "redirect_url": "/powershell/module/teams/New-CsCallingLineIdentity", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsCallingLineIdentity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsCallQueue.md", - "redirect_url": "/powershell/module/teams/New-CsCallQueue", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsCallQueue", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsEdgeAllowAllKnownDomains.md", - "redirect_url": "/powershell/module/teams/New-CsEdgeAllowAllKnownDomains", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsEdgeAllowList.md", - "redirect_url": "/powershell/module/teams/New-CsEdgeAllowList", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsEdgeAllowList", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsEdgeDomainPattern.md", - "redirect_url": "/powershell/module/teams/New-CsEdgeDomainPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsEdgeDomainPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsInboundBlockedNumberPattern.md", - "redirect_url": "/powershell/module/teams/New-CsInboundBlockedNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsInboundBlockedNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsInboundExemptNumberPattern.md", - "redirect_url": "/powershell/module/teams/New-CsInboundExemptNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsInboundExemptNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationInstance.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationInstanceAssociation.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineApplicationInstanceAssociation", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineDateTimeRange.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineDateTimeRange", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineDateTimeRange", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineLisCivicAddress.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineLisCivicAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineLisCivicAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineLisLocation.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineLisLocation", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineLisLocation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlinePSTNGateway.md", - "redirect_url": "/powershell/module/teams/New-CsOnlinePSTNGateway", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlinePSTNGateway", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineSchedule.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineSchedule", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineSchedule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineTimeRange.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineTimeRange", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineTimeRange", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineVoicemailPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineVoicemailPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineVoicemailPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineVoiceRoute.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineVoiceRoute", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineVoiceRoute", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineVoiceRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsOnlineVoiceRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsAppPermissionPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsAppPermissionPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsAppPermissionPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsAppSetupPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsAppSetupPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsAppSetupPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsAudioConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsAudioConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsCallHoldPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsCallHoldPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCallHoldPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsCallingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsCallParkPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsCallParkPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCallParkPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsChannelsPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsChannelsPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsChannelsPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingApplication.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingApplication", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingPairedApplication.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingPairedApplication", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsCortanaPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsCortanaPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsCortanaPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallingExtendedNotification.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallingExtendedNotification", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyNumber.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsEmergencyNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsFeedbackPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsFeedbackPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsFeedbackPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsIPPhonePolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsIPPhonePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsIPPhonePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingBrandingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingBrandingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingBroadcastPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingBroadcastPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsMessagingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsMessagingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMessagingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsMobilityPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsMobilityPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsMobilityPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsNetworkRoamingPolicy.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsNetworkRoamingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsPinnedApp.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsPinnedApp", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsPinnedApp", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTeamsTranslationRule.md", - "redirect_url": "/powershell/module/teams/New-CsTeamsTranslationRule", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTeamsTranslationRule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/New-CsTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkRegion.md", - "redirect_url": "/powershell/module/teams/New-CsTenantNetworkRegion", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantNetworkRegion", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkSite.md", - "redirect_url": "/powershell/module/teams/New-CsTenantNetworkSite", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantNetworkSite", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkSubnet.md", - "redirect_url": "/powershell/module/teams/New-CsTenantNetworkSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantNetworkSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsTenantTrustedIPAddress.md", - "redirect_url": "/powershell/module/teams/New-CsTenantTrustedIPAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsTenantTrustedIPAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsVideoInteropServiceProvider.md", - "redirect_url": "/powershell/module/teams/New-CsVideoInteropServiceProvider", + "redirect_url": "/powershell/module/MicrosoftTeams/New-CsVideoInteropServiceProvider", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Register-CsOnlineDialInConferencingServiceNumber.md", - "redirect_url": "/powershell/module/teams/Register-CsOnlineDialInConferencingServiceNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsApplicationAccessPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsApplicationAccessPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsAutoAttendant.md", - "redirect_url": "/powershell/module/teams/Remove-CsAutoAttendant", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsAutoAttendant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsCallingLineIdentity.md", - "redirect_url": "/powershell/module/teams/Remove-CsCallingLineIdentity", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsCallingLineIdentity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsCallQueue.md", - "redirect_url": "/powershell/module/teams/Remove-CsCallQueue", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsCallQueue", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsInboundBlockedNumberPattern.md", - "redirect_url": "/powershell/module/teams/Remove-CsInboundBlockedNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsInboundExemptNumberPattern.md", - "redirect_url": "/powershell/module/teams/Remove-CsInboundExemptNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsInboundExemptNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineApplicationInstanceAssociation.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineApplicationInstanceAssociation", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineAudioFile.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineAudioFile", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineAudioFile", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineDialInConferencingTenantSettings.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineDialInConferencingTenantSettings", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisCivicAddress.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisCivicAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisCivicAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisLocation.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisLocation", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisLocation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisPort.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisPort", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisPort", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisSubnet.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisSwitch.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisSwitch", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisSwitch", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisWirelessAccessPoint.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisWirelessAccessPoint", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlinePSTNGateway.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlinePSTNGateway", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlinePSTNGateway", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineSchedule.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineSchedule", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineSchedule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineTelephoneNumber.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineTelephoneNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineTelephoneNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoicemailPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoicemailPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoiceRoute.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoiceRoute", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineVoiceRoute", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoiceRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoiceRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAppPermissionPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsAppPermissionPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAppSetupPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsAppSetupPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAudioConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsAudioConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallHoldPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallHoldPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallParkPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallParkPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCallParkPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsChannelsPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsChannelsPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsChannelsPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsComplianceRecordingApplication.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsComplianceRecordingApplication", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsComplianceRecordingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsComplianceRecordingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCortanaPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsCortanaPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsCortanaPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsEmergencyCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsEmergencyCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsEmergencyCallRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsEmergencyCallRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsFeedbackPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsFeedbackPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsIPPhonePolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsIPPhonePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingBrandingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingBrandingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingBroadcastPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingBroadcastPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMessagingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsMessagingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMessagingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMobilityPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsMobilityPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsMobilityPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsNetworkRoamingPolicy.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsNetworkRoamingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsPinnedApp.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsPinnedApp", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsPinnedApp", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTeamsTranslationRule.md", - "redirect_url": "/powershell/module/teams/Remove-CsTeamsTranslationRule", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTeamsTranslationRule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Remove-CsTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkRegion.md", - "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkRegion", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantNetworkRegion", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkSite.md", - "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkSite", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantNetworkSite", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkSubnet.md", - "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantNetworkSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsTenantTrustedIPAddress.md", - "redirect_url": "/powershell/module/teams/Remove-CsTenantTrustedIPAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsTenantTrustedIPAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsVideoInteropServiceProvider.md", - "redirect_url": "/powershell/module/teams/Remove-CsVideoInteropServiceProvider", + "redirect_url": "/powershell/module/MicrosoftTeams/Remove-CsVideoInteropServiceProvider", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsApplicationAccessPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsApplicationAccessPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsApplicationAccessPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsApplicationMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsApplicationMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsApplicationMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsAutoAttendant.md", - "redirect_url": "/powershell/module/teams/Set-CsAutoAttendant", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsAutoAttendant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsCallingLineIdentity.md", - "redirect_url": "/powershell/module/teams/Set-CsCallingLineIdentity", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsCallingLineIdentity", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsCallQueue.md", - "redirect_url": "/powershell/module/teams/Set-CsCallQueue", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsCallQueue", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsInboundBlockedNumberPattern.md", - "redirect_url": "/powershell/module/teams/Set-CsInboundBlockedNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsInboundBlockedNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsInboundExemptNumberPattern.md", - "redirect_url": "/powershell/module/teams/Set-CsInboundExemptNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsInboundExemptNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineApplicationInstance.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingBridge.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingBridge", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingServiceNumber.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingServiceNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingTenantSettings.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingTenantSettings", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingUser.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingUser", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingUser", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingUserDefaultNumber.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingUserDefaultNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineDialInConferencingUserDefaultNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisCivicAddress.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisCivicAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisCivicAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisLocation.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisLocation", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisLocation", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisPort.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisPort", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisPort", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisSubnet.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisSwitch.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisSwitch", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisSwitch", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisWirelessAccessPoint.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineLisWirelessAccessPoint", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlinePSTNGateway.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlinePSTNGateway", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlinePSTNGateway", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlinePstnUsage.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlinePstnUsage", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlinePstnUsage", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineSchedule.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineSchedule", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineSchedule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceApplicationInstance.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoicemailPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoicemailPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoicemailPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoicemailUserSettings.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoicemailUserSettings", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceRoute.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceRoute", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceRoute", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceUser.md", - "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceUser", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsOnlineVoiceUser", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsAppPermissionPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsAppPermissionPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsAppSetupPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsAppSetupPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsAppSetupPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsAudioConferencingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsAudioConferencingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallHoldPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsCallHoldPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCallHoldPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallParkPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsCallParkPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCallParkPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsChannelsPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsChannelsPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsChannelsPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsClientConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsClientConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsClientConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsComplianceRecordingApplication.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsComplianceRecordingApplication", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsComplianceRecordingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsComplianceRecordingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsCortanaPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsCortanaPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsCortanaPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsEducationAssignmentsAppPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsEducationAssignmentsAppPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsEmergencyCallingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsEmergencyCallingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsEmergencyCallRoutingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsEmergencyCallRoutingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsFeedbackPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsFeedbackPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsFeedbackPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestCallingConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestCallingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestMessagingConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestMessagingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsIPPhonePolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsIPPhonePolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsIPPhonePolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBrandingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBrandingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBroadcastConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBroadcastConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBroadcastPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBroadcastPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMeetingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMessagingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMessagingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMessagingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsMobilityPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsMobilityPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsMobilityPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsNetworkRoamingPolicy.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsNetworkRoamingPolicy", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsPinnedApp.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsPinnedApp", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsPinnedApp", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTeamsTranslationRule.md", - "redirect_url": "/powershell/module/teams/Set-CsTeamsTranslationRule", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTeamsTranslationRule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantBlockedCallingNumbers.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantBlockedCallingNumbers", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantFederationConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantFederationConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantFederationConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantMigrationConfiguration.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantMigrationConfiguration", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantMigrationConfiguration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkRegion.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkRegion", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantNetworkRegion", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkSite.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkSite", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantNetworkSite", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkSubnet.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkSubnet", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantNetworkSubnet", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantTrustedIPAddress.md", - "redirect_url": "/powershell/module/teams/Set-CsTenantTrustedIPAddress", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsTenantTrustedIPAddress", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServiceProvider.md", - "redirect_url": "/powershell/module/teams/Set-CsVideoInteropServiceProvider", + "redirect_url": "/powershell/module/MicrosoftTeams/Set-CsVideoInteropServiceProvider", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Start-CsExMeetingMigration.md", - "redirect_url": "/powershell/module/teams/Start-CsExMeetingMigration", + "redirect_url": "/powershell/module/MicrosoftTeams/Start-CsExMeetingMigration", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Sync-CsOnlineApplicationInstance.md", - "redirect_url": "/powershell/module/teams/Sync-CsOnlineApplicationInstance", + "redirect_url": "/powershell/module/MicrosoftTeams/Sync-CsOnlineApplicationInstance", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsEffectiveTenantDialPlan.md", - "redirect_url": "/powershell/module/teams/Test-CsEffectiveTenantDialPlan", + "redirect_url": "/powershell/module/MicrosoftTeams/Test-CsEffectiveTenantDialPlan", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsInboundBlockedNumberPattern.md", - "redirect_url": "/powershell/module/teams/Test-CsInboundBlockedNumberPattern", + "redirect_url": "/powershell/module/MicrosoftTeams/Test-CsInboundBlockedNumberPattern", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsTeamsTranslationRule.md", - "redirect_url": "/powershell/module/teams/Test-CsTeamsTranslationRule", + "redirect_url": "/powershell/module/MicrosoftTeams/Test-CsTeamsTranslationRule", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md", - "redirect_url": "/powershell/module/teams/Unregister-CsOnlineDialInConferencingServiceNumber", + "redirect_url": "/powershell/module/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Update-CsAutoAttendant.md", - "redirect_url": "/powershell/module/teams/Update-CsAutoAttendant", + "redirect_url": "/powershell/module/MicrosoftTeams/Update-CsAutoAttendant", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Clear-CsOnlineTelephoneNumberReservation.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Disable-CsOnlineDialInConferencingUser.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Enable-CsOnlineDialInConferencingUser.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Export-CsOrganizationalAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsHuntGroup.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsHuntGroupTenantInformation.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationEndpoint.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUserInfo.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUserState.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineDirectoryTenantNumberCities.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineNumberPortInOrder.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineNumberPortOutOrderPin.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberAvailableCount.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryCities.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendant.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantStatus.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTeamsUpgradeStatus.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Get-CsTenantPublicProvider.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Grant-CsBroadcastMeetingPolicy.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Import-CsOrganizationalAutoAttendantHolidays.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsHuntGroup.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationEndpoint.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineAudioFile.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineBulkAssignmentInput.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineNumberPortInOrder.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOnlineSession.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendant.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallableEntity.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallFlow.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantDialScope.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantMenu.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantMenuOption.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantPrompt.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsHuntGroup.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineApplicationEndpoint.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOnlineNumberPortInOrder.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Remove-CsOrganizationalAutoAttendant.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Search-CsOnlineTelephoneNumberInventory.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Select-CsOnlineTelephoneNumberInventory.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsHuntGroup.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineApplicationEndpoint.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineDirectoryUser.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineNumberPortInOrder.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineNumberPortOutOrderPin.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceUserBulk.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsOrganizationalAutoAttendant.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Set-CsTenantPublicProvider.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsOnlineCarrierPortabilityIn.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsOnlineLisCivicAddress.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Test-CsOnlinePortabilityIn.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { "source_path": "skype/virtual-folder/skype/Update-CsOrganizationalAutoAttendant.md", - "redirect_url": "/powershell/module/teams/", + "redirect_url": "/powershell/module/MicrosoftTeams/", "redirect_document_id": false }, { diff --git a/.openpublishing.redirection.teams.json b/.openpublishing.redirection.teams.json index ca0a088c34..7076d5b588 100644 --- a/.openpublishing.redirection.teams.json +++ b/.openpublishing.redirection.teams.json @@ -2,7 +2,3007 @@ "redirections": [ { "source_path": "teams/docs-conceptual/intro.md", - "redirect_url": "/powershell/teams", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Add-TeamChannelUser.md", + "redirect_url": "/powershell/module/microsoftteams/add-teamchanneluser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Add-TeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/add-teamuser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/clear-csonlinetelephonenumberorder", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md", + "redirect_url": "/powershell/module/microsoftteams/clear-teamsenvironmentconfig", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/complete-csonlinetelephonenumberorder", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Connect-MicrosoftTeams.md", + "redirect_url": "/powershell/module/microsoftteams/connect-microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Disable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/microsoftteams/disable-csonlinesipdomain", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Disconnect-MicrosoftTeams.md", + "redirect_url": "/powershell/module/microsoftteams/disconnect-microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Enable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/microsoftteams/enable-csonlinesipdomain", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/export-csacquiredphonenumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/microsoftteams/export-csautoattendantholidays", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Find-CsGroup.md", + "redirect_url": "/powershell/module/microsoftteams/find-csgroup", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/find-csonlineapplicationinstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-ALLM365TeamsApps.md", + "redirect_url": "/powershell/module/microsoftteams/get-allm365teamsapps", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-AssociatedTeam.md", + "redirect_url": "/powershell/module/microsoftteams/get-associatedteam", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csapplicationaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csapplicationmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendant", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantholidays", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsAutoAttendantStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantstatus", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantsupportedlanguage", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendantsupportedtimezone", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csautoattendanttenantinformation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csbatchpolicyassignmentoperation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csbatchteamsdeploymentstatus", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscallqueue", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscallinglineidentity", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsCloudCallDataConnection.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscloudcalldataconnection", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/get-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/get-cseffectivetenantdialplan", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csexportacquiredphonenumberstatus", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csexternalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csgrouppolicyassignment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/get-cshybridtelephonenumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/get-csinboundblockednumberpattern", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/get-csinboundexemptnumberpattern", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csmeetingmigrationstatus", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineapplicationinstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineapplicationinstanceassociationstatus", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineaudiofile", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingbridge", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencinglanguagessupported", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingservicenumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantsettings", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencinguser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialoutpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedialinconferencingtenantconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinedirectorytenant", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineenhancedemergencyservicedisclaimer", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineliscivicaddress", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelislocation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelisport", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelissubnet", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinelisswitch", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineliswirelessaccesspoint", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinepstngateway", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinepstnusage", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineschedule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinesipdomain", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumbercountry", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumberorder", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinetelephonenumbertype", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlineuser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoiceroute", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoiceroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoiceuser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoicemailpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-csonlinevoicemailusersettings", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csphonenumberassignment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/get-csphonenumbertag", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/get-cspolicypackage", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-cssdgbulksigninrequeststatus", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md", + "redirect_url": "/powershell/module/microsoftteams/get-cssdgbulksigninrequestssummary", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/get-cssharedcallqueuehistorytemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamtemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamTemplateList.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamtemplatelist", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsaipolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsacsfederationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsapppermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsappsetuppolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsaudioconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscallholdpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscallparkpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscallingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamschannelspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsclientconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscompliancerecordingapplication", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscompliancerecordingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscortanapolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamseducationassignmentsapppolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsEducationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamseducationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsemergencycallroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsemergencycallingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsenhancedencryptionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamseventspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsexternalaccessconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsfeedbackpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsfilespolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsfirstpartymeetingtemplateconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsguestcallingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsguestmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsguestmessagingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsipphonepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmediaconnectivitypolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmedialoggingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingbrandingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingbroadcastconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingbroadcastpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingtemplateconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmessagingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmobilitypolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmultitenantorganizationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsnetworkroamingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsnotificationandfeedspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsrecordingrolloutpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssettingscustomapp", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssharedcallingroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsapppolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnection", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionconnector", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionerrorreport", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectioninstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionoperation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionsyncresult", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionteammap", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmteam", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftsconnectionwfmuser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsshiftspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssipdevicesconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssurvivablebranchappliance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamstargetingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamstemplatepermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamstranslationrule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsunassignednumbertreatment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsupdatemanagementpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsupgradeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsupgradepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvdipolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvideointeropservicepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvirtualappointmentspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsvoiceapplicationspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsworkloadpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsworklocationdetectionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenant.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenant", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantblockedcallingnumbers", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantdialplan", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantfederationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantlicensingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantmigrationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworkregion", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworksite", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenantnetworksubnet", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/get-cstenanttrustedipaddress", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsUserCallingSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-csusercallingsettings", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsUserPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/get-csuserpolicyassignment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsUserPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/get-csuserpolicypackage", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md", + "redirect_url": "/powershell/module/microsoftteams/get-csuserpolicypackagerecommendation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/get-csvideointeropserviceprovider", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-M365TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/get-m365teamsapp", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md", + "redirect_url": "/powershell/module/microsoftteams/get-m365unifiedcustompendingapps", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/get-m365unifiedtenantsettings", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-SharedWithTeam.md", + "redirect_url": "/powershell/module/microsoftteams/get-sharedwithteam", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-SharedWithTeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-sharedwithteamuser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-Team.md", + "redirect_url": "/powershell/module/microsoftteams/get-team", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamAllChannel.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamallchannel", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamchannel", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamChannelUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamchanneluser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamIncomingChannel.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamincomingchannel", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamtargetinghierarchystatus", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamuser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/get-teamsapp", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csapplicationaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/grant-cscallinglineidentity", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsDialoutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csdialoutpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csexternalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csgrouppolicypackageassignment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csonlinevoiceroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csonlinevoicemailpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsaipolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsapppermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsappsetuppolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsaudioconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscallholdpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscallparkpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscallingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamschannelspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscompliancerecordingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamscortanapolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsemergencycallroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsemergencycallingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsenhancedencryptionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamseventspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsfeedbackpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsfilespolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsipphonepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmediaconnectivitypolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmedialoggingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingbrandingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingbroadcastpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmessagingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsmobilitypolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsrecordingrolloutpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamssharedcallingroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsshiftspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsupdatemanagementpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsupgradepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvdipolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvideointeropservicepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvirtualappointmentspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsvoiceapplicationspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsworkloadpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csteamsworklocationdetectionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/grant-cstenantdialplan", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsUserPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/grant-csuserpolicypackage", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/microsoftteams/import-csautoattendantholidays", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Import-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/microsoftteams/import-csonlineaudiofile", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csapplicationaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendant", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantcallflow", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantcallhandlingassociation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantcallableentity", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsAutoAttendantDialScope.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantdialscope", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsAutoAttendantMenu.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantmenu", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantmenuoption", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsAutoAttendantPrompt.md", + "redirect_url": "/powershell/module/microsoftteams/new-csautoattendantprompt", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csbatchpolicyassignmentoperation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csbatchpolicypackageassignmentoperation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsBatchTeamsDeployment.md", + "redirect_url": "/powershell/module/microsoftteams/new-csbatchteamsdeployment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscallqueue", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscallinglineidentity", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsCloudCallDataConnection.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscloudcalldataconnection", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsCustomPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/new-cscustompolicypackage", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md", + "redirect_url": "/powershell/module/microsoftteams/new-csedgeallowallknowndomains", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsEdgeAllowList.md", + "redirect_url": "/powershell/module/microsoftteams/new-csedgeallowlist", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsEdgeDomainPattern.md", + "redirect_url": "/powershell/module/microsoftteams/new-csedgedomainpattern", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csexternalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/new-csgrouppolicyassignment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsHybridTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/new-cshybridtelephonenumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/new-csinboundblockednumberpattern", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/new-csinboundexemptnumberpattern", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineapplicationinstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineapplicationinstanceassociation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineDateTimeRange.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinedatetimerange", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinedirectroutingtelephonenumberuploadorder", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineliscivicaddress", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinelislocation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinepstngateway", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlineschedule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinetelephonenumberorder", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinetelephonenumberreleaseorder", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineTimeRange.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinetimerange", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinevoiceroute", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinevoiceroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csonlinevoicemailpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md", + "redirect_url": "/powershell/module/microsoftteams/new-cssdgbulksigninrequest", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-cssharedcallqueuehistorytemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamtemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsaipolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsapppermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsappsetuppolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsaudioconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscallholdpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscallparkpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscallingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamschannelspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscompliancerecordingapplication", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscompliancerecordingpairedapplication", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscompliancerecordingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscortanapolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencycallroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencycallingextendednotification", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencycallingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsemergencynumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsenhancedencryptionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamseventspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsfeedbackpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsfilespolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamshiddenmeetingtemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamshiddentemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsipphonepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmediaconnectivitypolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingbrandingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingbroadcastpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmessagingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsmobilitypolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsnetworkroamingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsrecordingrolloutpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamssharedcallingroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftsconnection", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftsconnectionbatchteammap", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftsconnectioninstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsshiftspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamssurvivablebranchappliance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamstemplatepermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamstranslationrule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsunassignednumbertreatment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsupdatemanagementpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsvdipolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsvirtualappointmentspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsvoiceapplicationspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsworkloadpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/new-csteamsworklocationdetectionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantdialplan", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantnetworkregion", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantnetworksite", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenantnetworksubnet", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/new-cstenanttrustedipaddress", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsUserCallingDelegate.md", + "redirect_url": "/powershell/module/microsoftteams/new-csusercallingdelegate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/new-csvideointeropserviceprovider", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/microsoftteams/new-csvoicenormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-Team.md", + "redirect_url": "/powershell/module/microsoftteams/new-team", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/new-teamchannel", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/new-teamsapp", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/register-csonlinedialinconferencingservicenumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csapplicationaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csautoattendant", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscallqueue", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscallinglineidentity", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cscustompolicypackage", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csexternalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csgrouppolicyassignment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cshybridtelephonenumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csinboundblockednumberpattern", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csinboundexemptnumberpattern", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineapplicationinstanceassociation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineaudiofile", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinedialinconferencingtenantsettings", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineliscivicaddress", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelislocation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelisport", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelissubnet", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinelisswitch", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineliswirelessaccesspoint", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinepstngateway", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlineschedule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinetelephonenumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinevoiceroute", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinevoiceroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csonlinevoicemailpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csphonenumberassignment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csphonenumbertag", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cssharedcallqueuehistorytemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamtemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsaipolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsapppermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsappsetuppolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsaudioconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscallholdpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscallparkpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscallingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamschannelspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscompliancerecordingapplication", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscompliancerecordingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscortanapolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsemergencycallroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsemergencycallingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsenhancedencryptionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamseventspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsfeedbackpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsfilespolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsipphonepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmediaconnectivitypolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingbrandingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingbroadcastpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmessagingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsmobilitypolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsnetworkroamingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsnotificationandfeedspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsrecordingrolloutpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamssharedcallingroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsconnection", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsconnectioninstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsconnectionteammap", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsshiftsschedulerecord", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamssurvivablebranchappliance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamstargetingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamstemplatepermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamstranslationrule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsunassignednumbertreatment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsupdatemanagementpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsvdipolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsvirtualappointmentspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsvoiceapplicationspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsworkloadpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csteamsworklocationdetectionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantdialplan", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantnetworkregion", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantnetworksite", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenantnetworksubnet", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/remove-cstenanttrustedipaddress", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsUserCallingDelegate.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csusercallingdelegate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csuserlicensegraceperiod", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/remove-csvideointeropserviceprovider", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-SharedWithTeam.md", + "redirect_url": "/powershell/module/microsoftteams/remove-sharedwithteam", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-Team.md", + "redirect_url": "/powershell/module/microsoftteams/remove-team", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamchannel", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-TeamChannelUser.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamchanneluser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamtargetinghierarchy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-TeamUser.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamuser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/remove-teamsapp", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csapplicationaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csapplicationmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/set-csautoattendant", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsCallQueue.md", + "redirect_url": "/powershell/module/microsoftteams/set-cscallqueue", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/microsoftteams/set-cscallinglineidentity", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/set-cscompliancerecordingforcallqueuetemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csexternalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/set-csinboundblockednumberpattern", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/set-csinboundexemptnumberpattern", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineapplicationinstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineaudioconferencingroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencingbridge", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencingservicenumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencingtenantsettings", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinedialinconferencinguser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineenhancedemergencyservicedisclaimer", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineliscivicaddress", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelislocation", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelisport", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelissubnet", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinelisswitch", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineliswirelessaccesspoint", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinepstngateway", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinepstnusage", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlineschedule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceapplicationinstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceroute", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoiceuser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoicemailpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/microsoftteams/set-csonlinevoicemailusersettings", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md", + "redirect_url": "/powershell/module/microsoftteams/set-csphonenumberassignment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/set-csphonenumbertag", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/set-cssharedcallqueuehistorytemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsAIPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsaipolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsacsfederationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsapppermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsappsetuppolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsaudioconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscallholdpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscallparkpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscallingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamschannelspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsclientconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscompliancerecordingapplication", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscompliancerecordingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscortanapolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamscustombannertext", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamseducationassignmentsapppolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamseducationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsemergencycallroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsemergencycallingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsenhancedencryptionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamseventspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsexternalaccessconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsfeedbackpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsfilespolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsguestcallingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsguestmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsguestmessagingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsipphonepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmediaconnectivitypolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingbrandingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingbroadcastconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingbroadcastpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmeetingtemplatepermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmessagingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmobilitypolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmultitenantorganizationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsnetworkroamingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsnotificationandfeedspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsrecordingrolloutpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsroomvideoteleconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssettingscustomapp", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssharedcallingroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftsapppolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftsconnection", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftsconnectioninstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsshiftspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssipdevicesconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssurvivablebranchappliance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamssurvivablebranchappliancepolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamstargetingpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamstemplatepermissionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamstranslationrule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsunassignednumbertreatment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsupdatemanagementpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsupgradeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsvdipolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsvirtualappointmentspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsvoiceapplicationspolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsworkloadpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsworklocationdetectionpolicy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantblockedcallingnumbers", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantdialplan", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantfederationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantmigrationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantnetworkregion", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantnetworksite", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenantnetworksubnet", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/microsoftteams/set-cstenanttrustedipaddress", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsUser.md", + "redirect_url": "/powershell/module/microsoftteams/set-csuser", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsUserCallingDelegate.md", + "redirect_url": "/powershell/module/microsoftteams/set-csusercallingdelegate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsUserCallingSettings.md", + "redirect_url": "/powershell/module/microsoftteams/set-csusercallingsettings", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/microsoftteams/set-csvideointeropserviceprovider", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-Team.md", + "redirect_url": "/powershell/module/microsoftteams/set-team", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-TeamArchivedState.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamarchivedstate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-TeamChannel.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamchannel", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-TeamPicture.md", + "redirect_url": "/powershell/module/microsoftteams/set-teampicture", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-TeamTargetingHierarchy.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamtargetinghierarchy", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamsapp", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md", + "redirect_url": "/powershell/module/microsoftteams/set-teamsenvironmentconfig", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Start-CsExMeetingMigration.md", + "redirect_url": "/powershell/module/microsoftteams/start-csexmeetingmigration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/microsoftteams/sync-csonlineapplicationinstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams/test-cseffectivetenantdialplan", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/microsoftteams/test-csinboundblockednumberpattern", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md", + "redirect_url": "/powershell/module/microsoftteams/test-csteamsshiftsconnectionvalidate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Test-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/microsoftteams/test-csteamstranslationrule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md", + "redirect_url": "/powershell/module/microsoftteams/test-csteamsunassignednumbertreatment", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/microsoftteams/test-csvoicenormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/microsoftteams/unregister-csonlinedialinconferencingservicenumber", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Update-CsAutoAttendant.md", + "redirect_url": "/powershell/module/microsoftteams/update-csautoattendant", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Update-CsCustomPolicyPackage.md", + "redirect_url": "/powershell/module/microsoftteams/update-cscustompolicypackage", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Update-CsPhoneNumberTag.md", + "redirect_url": "/powershell/module/microsoftteams/update-csphonenumbertag", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Update-CsTeamTemplate.md", + "redirect_url": "/powershell/module/microsoftteams/update-csteamtemplate", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md", + "redirect_url": "/powershell/module/microsoftteams/update-csteamsshiftsconnection", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md", + "redirect_url": "/powershell/module/microsoftteams/update-csteamsshiftsconnectioninstance", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Update-M365TeamsApp.md", + "redirect_url": "/powershell/module/microsoftteams/update-m365teamsapp", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md", + "redirect_url": "/powershell/module/microsoftteams/update-m365unifiedcustompendingapp", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md", + "redirect_url": "/powershell/module/microsoftteams/update-m365unifiedtenantsettings", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/export-csonlineaudiofile.md", + "redirect_url": "/powershell/module/microsoftteams/export-csonlineaudiofile", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/get-csteamsmessagingconfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/get-csteamsmessagingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/set-csteamsmessagingconfiguration.md", + "redirect_url": "/powershell/module/microsoftteams/set-csteamsmessagingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Add-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsDialPlan.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamFunSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamGuestSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamMemberSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamMessagingSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Get-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Remove-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-TeamFunSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-TeamGuestSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-TeamMemberSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Set-TeamMessagingSettings.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/Update-TeamsAppInstallation.md", + "redirect_url": "/powershell/module/microsoftteams", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/teams.md", + "redirect_url": "/powershell/module/microsoftteams", "redirect_document_id": false } ] diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md index 5f8470dadc..e03059b3f9 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelBIServer.md @@ -12,7 +12,9 @@ ms.reviewer: # Get-OfficeWebAppsExcelBIServer ## SYNOPSIS -Returns the server ID of the instance of Analysis Services that has been configured as a data model server in Office Online Server. + +Returns the server ID of the instance of Analysis Services that has been configured as a data model +server in Office Online Server. ## SYNTAX @@ -21,12 +23,15 @@ Get-OfficeWebAppsExcelBIServer ``` ## DESCRIPTION -Returns the server ID of the instance of Analysis Services that has been configured as a data model server in Office Online Server. + +Returns the server ID of the instance of Analysis Services that has been configured as a data model +server in Office Online Server. ## EXAMPLES ### Example 1 -``` + +```powershell Get-OfficeWebAppsExcelBIServer ``` diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md index 1af1fd7bb1..dee6470e64 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Returns a list of currently configured UDF definitions. ## SYNTAX @@ -21,24 +22,27 @@ Get-OfficeWebAppsExcelUserDefinedFunction [[-Identity] ] ``` ## DESCRIPTION + Returns a list of currently configured UDF definitions. ## EXAMPLES ### This example returns a list of currently configured UDF definitions from c:\myudf.dll. -``` + +```powershell Get-OfficeWebAppsExcelUserDefinedFunction -Identity c:\myudf.dll ``` ## PARAMETERS ### -Identity + The path and filename of the UDF. ```yaml Type: UserDefinedFunction Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md index 0d27a73bb7..168bf69836 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsFarm.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsFarm ## SYNOPSIS + Returns details about the OfficeWebAppsFarm object that the current server is a member of. ## SYNTAX @@ -21,21 +22,25 @@ Get-OfficeWebAppsFarm ``` ## DESCRIPTION -The Get-OfficeWebAppsFarm cmdlet returns details about the OfficeWebAppsFarm object that the current server is a member of. -This object represents a group of servers that work as a unit to provide web-based editing and viewing of Office documents. -No parameters are used with the Get-OfficeWebAppsFarm cmdlet. + +The `Get-OfficeWebAppsFarm` cmdlet returns details about the OfficeWebAppsFarm object that the +current server is a member of. This object represents a group of servers that work as a unit to +provide web-based editing and viewing of Office documents. No parameters are used with the +`Get-OfficeWebAppsFarm` cmdlet. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Get-OfficeWebAppsFarm ``` This example returns details about the OfficeWebAppsFarm object. ### EXAMPLE 2 -``` + +```powershell (Get-OfficeWebAppsFarm).Machines ``` diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md index 034526892b..d034e6df00 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsHost.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsHost ## SYNOPSIS + Returns the list of host domains that are on the Allow List for an Office Online Server farm. ## SYNTAX @@ -21,34 +22,41 @@ Get-OfficeWebAppsHost ``` ## DESCRIPTION -The Get-OfficeWebAppsHost cmdlet returns the list of host domains to which Office Online Server allows file operations requests, such as file retrieval, metadata retrieval, and file changes. -This list, known as the Allow List, is a security feature that prevents unwanted hosts from connecting to an Office Online Server farm and using it for file operations without your knowledge. -The wildcard * is assumed for any domain that appears on the Allow List so that requests to all subdomains are also allowed. -For example, if the domain contoso.com is on the Allow List, then Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. +The Get-OfficeWebAppsHost cmdlet returns the list of host domains to which Office Online Server +allows file operations requests, such as file retrieval, metadata retrieval, and file changes. This +list, known as the Allow List, is a security feature that prevents unwanted hosts from connecting to +an Office Online Server farm and using it for file operations without your knowledge. + +The wildcard * is assumed for any domain that appears on the Allow List so that requests to all +subdomains are also allowed. For example, if the domain contoso.com is on the Allow List, then +Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. Requests to other domains (such as fabrikam.com) are not allowed. -If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any domain. -Do not leave this list blank if your Office Online Server farm is accessible from the Internet. -Otherwise anyone can use your Office Online Server farm to view and edit content. +If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any +domain. Do not leave this list blank if your Office Online Server farm is accessible from the +Internet. Otherwise anyone can use your Office Online Server farm to view and edit content. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Get-OfficeWebAppsHost ``` This example returns the host domains that are on the Allow List. ### EXAMPLE 2 + If there are multiple domains in the Allow List, please run the following: -``` +```powershell Get-OfficeWebAppsHost | Select allowList -ExpandProperty allowList ``` -This example returns the host domains that are on the Allow List without ellipsis truncation in the case of multiple domains. +This example returns the host domains that are on the Allow List without ellipsis truncation in the +case of multiple domains. ## PARAMETERS diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md index 034f6f4408..f0588a4a6f 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # Get-OfficeWebAppsMachine ## SYNOPSIS + Returns details about the current server that is in an Office Online Server farm. ## SYNTAX @@ -21,20 +22,24 @@ Get-OfficeWebAppsMachine ``` ## DESCRIPTION -The Get-OfficeWebAppsMachine cmdlet returns details about the current server that is in an Office Online Server farm. -These details include the roles and health status of the current server and the name of the master server for the farm. + +The Get-OfficeWebAppsMachine cmdlet returns details about the current server that is in an Office +Online Server farm. These details include the roles and health status of the current server and the +name of the master server for the farm. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Get-OfficeWebAppsMachine ``` This example returns details about the current server that is in an Office Online Server farm. ### EXAMPLE 2 -``` + +```powershell (Get-OfficeWebAppsFarm).Machines ``` diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md index 0640085f2b..ff4020acb3 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelBIServer.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsExcelBIServer ## SYNOPSIS + Configures Analysis Services servers to work with Excel Online. ## SYNTAX @@ -21,24 +22,29 @@ New-OfficeWebAppsExcelBIServer -ServerId ``` ## DESCRIPTION + Configures Analysis Services servers to work with Excel Online. ## EXAMPLES -### This example configures the Analysis Services server named SSAS01 to work with Excel Online. -``` +### Example 1 + +This example configures the Analysis Services server named SSAS01 to work with Excel Online. + +```powershell New-OfficeWebAppsExcelBIServer -ServerID "SSAS01" ``` ## PARAMETERS ### -ServerId + The name of the Analysis Services server. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md index c488ab7775..74ec676b53 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Creates a definition for a UDF binary. ## SYNTAX @@ -22,23 +23,33 @@ New-OfficeWebAppsExcelUserDefinedFunction -Assembly [-AssemblyLocation ``` ## DESCRIPTION + Creates a definition for a UDF binary. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell New-OfficeWebAppsExcelUserDefinedFunction -Assembly c:\myudf.dll -AssemblyLocation LocalFile -Enable:$true -Description "My Server UDFs" ``` ### EXAMPLE 2 -``` -New-OfficeWebAppsExcelUserDefinedFunction -Assembly "CompanyName.Hierarchical.MyUdfNamespace.MyUdfClassName.dll, Version=1.1.0.0, Culture=en, PublicKeyToken=e8123117d7ba9ae38" -AssemblyLocation GAC -Enable:$true -Description "My GAC Server UDFs" + +```powershell +$newOfficeWebAppsExcelUserDefinedFunctionSplat = @{ + Assembly = 'CompanyName.Hierarchical.MyUdfNamespace.MyUdfClassName.dll, Version=1.1.0.0, Culture=en, PublicKeyToken=e8123117d7ba9ae38' + AssemblyLocation = 'GAC' + Enable = $true + Description = "My GAC Server UDFs" +} +New-OfficeWebAppsExcelUserDefinedFunction @newOfficeWebAppsExcelUserDefinedFunctionSplat ``` ## PARAMETERS ### -Assembly + The name of the assembly. ```yaml @@ -54,8 +65,13 @@ Accept wildcard characters: False ``` ### -AssemblyLocation + The location of the assembly. -Values: LocalFile - a local directory; GAC - the Global Assembly Cache. + +Values: + +- LocalFile - a local directory +- GAC - the Global Assembly Cache ```yaml Type: AssemblyLocation @@ -70,8 +86,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -86,6 +102,7 @@ Accept wildcard characters: False ``` ### -Description + Description of the UDF. ```yaml @@ -101,6 +118,7 @@ Accept wildcard characters: False ``` ### -Enable + Enables the UDF. ```yaml @@ -116,8 +134,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md index 627e987140..df9e2f8c8d 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsFarm.md @@ -12,47 +12,58 @@ ms.reviewer: # New-OfficeWebAppsFarm ## SYNOPSIS + Creates a new Office Online Server farm on the local computer. ## SYNTAX ``` -New-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] [-AllowHttp] - [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] [-S2SCertificateName ] - [-EditingEnabled] [-Proxy ] [-LogLocation ] [-LogRetentionInDays ] - [-LogVerbosity ] [-CacheLocation ] [-MaxMemoryCacheSizeInMB ] - [-DocumentInfoCacheSize ] [-CacheSizeInGB ] [-ClipartEnabled] [-TranslationEnabled] - [-MaxTranslationCharacterCount ] [-TranslationServiceAppId ] - [-TranslationServiceAddress ] [-RenderingLocalCacheLocation ] - [-RecycleActiveProcessCount ] [-AllowCEIP] [-ExcelRequestDurationMax ] - [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] [-ExcelPrivateBytesMax ] - [-ExcelConnectionLifetime ] [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] - [-ExcelUseEffectiveUserName] [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] - [-ExcelMemoryCacheThreshold ] [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] - [-ExcelAbortOnRefreshOnOpenFail] [-ExcelAutomaticVolatileFunctionCacheLifeTime ] - [-ExcelConcurrentDataRequestsPerSessionMax ] [-ExcelDefaultWorkbookCalcMode ] - [-ExcelRestExternalDataEnabled] [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] - [-OpenFromUncEnabled] [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] - [-RemovePersonalInformationFromLogs] [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] +New-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] + [-AllowHttp] [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] + [-S2SCertificateName ] [-EditingEnabled] [-Proxy ] [-LogLocation ] + [-LogRetentionInDays ] [-LogVerbosity ] [-CacheLocation ] + [-MaxMemoryCacheSizeInMB ] [-DocumentInfoCacheSize ] [-CacheSizeInGB ] + [-ClipartEnabled] [-TranslationEnabled] [-MaxTranslationCharacterCount ] + [-TranslationServiceAppId ] [-TranslationServiceAddress ] + [-RenderingLocalCacheLocation ] [-RecycleActiveProcessCount ] [-AllowCEIP] + [-ExcelRequestDurationMax ] [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] + [-ExcelPrivateBytesMax ] [-ExcelConnectionLifetime ] + [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] [-ExcelUseEffectiveUserName] + [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] [-ExcelMemoryCacheThreshold ] + [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] [-ExcelAbortOnRefreshOnOpenFail] + [-ExcelAutomaticVolatileFunctionCacheLifeTime ] + [-ExcelConcurrentDataRequestsPerSessionMax ] + [-ExcelDefaultWorkbookCalcMode ] [-ExcelRestExternalDataEnabled] + [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] [-OpenFromUncEnabled] + [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] [-RemovePersonalInformationFromLogs] + [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The New-OfficeWebAppsFarm cmdlet creates a new Office Online Server farm on the local computer. -You run this cmdlet on the first server in the Office Online Server farm and then add more servers to the farm by using the New-OfficeWebAppsMachine cmdlet. + +The New-OfficeWebAppsFarm cmdlet creates a new Office Online Server farm on the local computer. You +run this cmdlet on the first server in the Office Online Server farm and then add more servers to +the farm by using the New-OfficeWebAppsMachine cmdlet. ## EXAMPLES ### EXAMPLE 1 + ``` New-OfficeWebAppsFarm -ExternalUrl "https://office.contoso.com" -CertificateName "Office Server Cert" -EditingEnabled:$true ``` -This example creates an Office Online Server farm on the local server that has editing enabled for Office in a browser. With this example, only a single URL is used for both internal and external users. The Certificate Name value is the Friendly Name of the certificate as it appears in the Computer's certificate store. +This example creates an Office Online Server farm on the local server that has editing enabled for +Office in a browser. With this example, only a single URL is used for both internal and external +users. The Certificate Name value is the Friendly Name of the certificate as it appears in the +Computer's certificate store. ## PARAMETERS ### -AllowCEIP -Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online Server farm. + +Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online +Server farm. ```yaml Type: SwitchParameter @@ -67,8 +78,10 @@ Accept wildcard characters: False ``` ### -AllowHttp -Indicates that IIS sites should be provisioned on port 80 for HTTP access. -Use AllowHTTP only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. + +Indicates that IIS sites should be provisioned on port 80 for HTTP access. Use AllowHTTP only in +environments where all computers require IPSEC (full encryption) or in test environments that do not +contain sensitive files. Enabled automatically when you enable SSLOffloaded. @@ -85,10 +98,12 @@ Accept wildcard characters: False ``` ### -AllowHttpSecureStoreConnections + Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). The default is False. -Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. +Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full +encryption) or in test environments that do not contain sensitive files. ```yaml Type: SwitchParameter @@ -103,6 +118,7 @@ Accept wildcard characters: False ``` ### -AllowOutboundHttp + Allows outbound HTTP connections from Office Online Server. ```yaml @@ -118,8 +134,9 @@ Accept wildcard characters: False ``` ### -CacheLocation -Specifies the location of the global disk cache that is used to store rendered image files. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\d\. + +Specifies the location of the global disk cache that is used to store rendered image files. The +default location is `%programdata%\Microsoft\OfficeWebApps\Working\d\`. ```yaml Type: String @@ -134,10 +151,11 @@ Accept wildcard characters: False ``` ### -CacheSizeInGB + Specifies the maximum size of the global disk cache in gigabytes. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 15 GB. +The type must be an integer value in the range of 0 to any positive integer. The default size is 15 +GB. ```yaml Type: Int32 @@ -152,14 +170,18 @@ Accept wildcard characters: False ``` ### -CertificateName -Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS bindings. -If the specified certificate is not found or has expired, or if the specified value is associated with more than one certificate, an error is logged and the farm is not created. +Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS +bindings. -This value is used on every server that joins the Office Online Server farm. -Therefore, every server in the farm must have a certificate that has this friendly name. +If the specified certificate is not found or has expired, or if the specified value is associated +with more than one certificate, an error is logged and the farm is not created. -You don't have to specify the CertificateName parameter if you are using either the AllowHttp or SSLOffloaded parameter. +This value is used on every server that joins the Office Online Server farm. Therefore, every server +in the farm must have a certificate that has this friendly name. + +You don't have to specify the CertificateName parameter if you are using either the AllowHttp or +SSLOffloaded parameter. ```yaml Type: String @@ -174,11 +196,12 @@ Accept wildcard characters: False ``` ### -ClipartEnabled -Enables support for inserting Bing images into Office documents. -This feature requires server-to-web communication, configured either directly or by using a proxy that you specify by using the Proxy parameter. -The OpenFromUrlEnabled parameter must be set to True for Bing Images to work.. -The default is False. +Enables support for inserting Bing images into Office documents. This feature requires server-to-web +communication, configured either directly or by using a proxy that you specify by using the Proxy +parameter. + +The OpenFromUrlEnabled parameter must be set to True for Bing Images to work.. The default is False. ```yaml Type: SwitchParameter @@ -193,8 +216,9 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters + +Prompts you for confirmation before executing the command. For more information, type the following +command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -209,6 +233,7 @@ Accept wildcard characters: False ``` ### -DocumentInfoCacheSize + Specifies the maximum number of document conversion records that are stored in a memory cache. The default value is 5000 records. @@ -226,9 +251,9 @@ Accept wildcard characters: False ``` ### -EditingEnabled -Enables support for editing in the browser. -The default is False. -Only set to True if you have the appropriate licensing to use the editing functionality. + +Enables support for editing in the browser. The default is False. Only set to True if you have the +appropriate licensing to use the editing functionality. ```yaml Type: SwitchParameter @@ -243,8 +268,9 @@ Accept wildcard characters: False ``` ### -ExcelAbortOnRefreshOnOpenFail -Prevents a workbook from loading if data refresh fails. -This helps prevent users from seeing out-of-date information or possibly information that they should not have access to. + +Prevents a workbook from loading if data refresh fails. This helps prevent users from seeing +out-of-date information or possibly information that they should not have access to. ```yaml Type: SwitchParameter @@ -259,8 +285,9 @@ Accept wildcard characters: False ``` ### -ExcelAllowExternalData -Enables the refresh of supported external data in Excel workbooks in a browser where workbooks contain connections to external data. -The default is True. + +Enables the refresh of supported external data in Excel workbooks in a browser where workbooks +contain connections to external data. The default is True. ```yaml Type: SwitchParameter @@ -275,10 +302,13 @@ Accept wildcard characters: False ``` ### -ExcelAutomaticVolatileFunctionCacheLifeTime -Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. --1: Calculates once when the workbook loads. -0: Always calculates. -1 to 2073600: Caches 1 second to 24 days. + +Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for +automatic recalculations. + +- -1: Calculates once when the workbook loads. +- 0: Always calculates. +- 1 to 2073600: Caches 1 second to 24 days. ```yaml Type: Int32 @@ -293,6 +323,7 @@ Accept wildcard characters: False ``` ### -ExcelCachingUnusedFiles + Enable caching of files that are no longer in use by Web Excel sessions. ```yaml @@ -308,8 +339,9 @@ Accept wildcard characters: False ``` ### -ExcelChartAndImageSizeMax -Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a browser. -The value must be an integer greater than 0. + +Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a +browser. The value must be an integer greater than 0. ```yaml Type: Int32 @@ -324,8 +356,9 @@ Accept wildcard characters: False ``` ### -ExcelConcurrentDataRequestsPerSessionMax -Specifies the maximum number of concurrent external data requests allowed in each session. -If a session must issue more than this number of requests, additional requests are queued. + +Specifies the maximum number of concurrent external data requests allowed in each session. If a +session must issue more than this number of requests, additional requests are queued. ```yaml Type: Int32 @@ -340,8 +373,9 @@ Accept wildcard characters: False ``` ### -ExcelConnectionLifetime -Specifies the duration, in seconds, of external data connections for Excel in a browser. -The default is 1800 seconds. + +Specifies the duration, in seconds, of external data connections for Excel in a browser. The default +is 1800 seconds. ```yaml Type: Int32 @@ -356,6 +390,7 @@ Accept wildcard characters: False ``` ### -ExcelDefaultWorkbookCalcMode + PARAMVALUE: File | Manual | Auto | AutoDataTables ```yaml @@ -371,8 +406,9 @@ Accept wildcard characters: False ``` ### -ExcelExternalDataCacheLifetime -Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. -The default is 300 seconds. + +Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. The +default is 300 seconds. ```yaml Type: Int32 @@ -387,9 +423,10 @@ Accept wildcard characters: False ``` ### -ExcelMemoryCacheThreshold -The percentage of the Maximum Private Bytes that can be allocated to inactive objects. -When the memory cache threshold is exceeded, cached objects that are not currently in use are released. -Valid values: 0 (disables caching of inactive objects); from 1 through 95. + +The percentage of the Maximum Private Bytes that can be allocated to inactive objects. When the +memory cache threshold is exceeded, cached objects that are not currently in use are released. Valid +values: 0 (disables caching of inactive objects); from 1 through 95. ```yaml Type: Int32 @@ -404,11 +441,11 @@ Accept wildcard characters: False ``` ### -ExcelPrivateBytesMax -Specifies the maximum private bytes, in megabytes, used by Excel in a browser. -When set to -1, the maximum private bytes use 50 percent of physical memory on the computer. -The type must be -1 or any positive integer. -The default value is -1. +Specifies the maximum private bytes, in megabytes, used by Excel in a browser. When set to -1, the +maximum private bytes use 50 percent of physical memory on the computer. + +The type must be -1 or any positive integer. The default value is -1. ```yaml Type: Int32 @@ -423,11 +460,11 @@ Accept wildcard characters: False ``` ### -ExcelRequestDurationMax -Specifies the maximum duration, in seconds, for a single request in a session. -After this time elapses, the request times out. -The type must be -1 (no limit) or an integer in the range of 1 to 2073600. -The default value is 300. +Specifies the maximum duration, in seconds, for a single request in a session. After this time +elapses, the request times out. + +The type must be -1 (no limit) or an integer in the range of 1 to 2073600. The default value is 300. ```yaml Type: Int32 @@ -442,10 +479,9 @@ Accept wildcard characters: False ``` ### -ExcelRestExternalDataEnabled -Allow requests from the REST API to refresh external data connections. -This setting has no effect if Allow External Data is set to None. -Check box Bool. -Default is False. + +Allow requests from the REST API to refresh external data connections. This setting has no effect if +Allow External Data is set to None. Check box Bool. Default is False. ```yaml Type: SwitchParameter @@ -460,14 +496,14 @@ Accept wildcard characters: False ``` ### -ExcelSessionTimeout -Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no user activity. -Valid values include the following: --1 Session never expires. +Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no +user activity. Valid values include the following: -0 Session expires at the end of a single request. +- -1 Session never expires. +- 0 Session expires at the end of a single request. +- 1 to 2073600Session remains active for 1 second to 24 days. -1 to 2073600Session remains active for 1 second to 24 days. The default value is 450. ```yaml @@ -483,8 +519,8 @@ Accept wildcard characters: False ``` ### -ExcelUdfsAllowed -Enables User Defined Functions for Excel in a browser. -The default is False. + +Enables User Defined Functions for Excel in a browser. The default is False. ```yaml Type: SwitchParameter @@ -499,9 +535,15 @@ Accept wildcard characters: False ``` ### -ExcelUnusedObjectAgeMax -The maximum time (in minutes) that inactive objects remain in the memory cache. -Inactive objects are objects that are not used in a session. -Valid values: -1 (no maximum); from 1 through 34560 (24 days). + +The maximum time (in minutes) that inactive objects remain in the memory cache. Inactive objects are +objects that are not used in a session. + +Valid values: + +- -1 (no maximum) +- 1 through 34560 (24 days). + Default is -1. ```yaml @@ -517,8 +559,9 @@ Accept wildcard characters: False ``` ### -ExcelUseEffectiveUserName -Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. -The default is False. + +Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. The +default is False. ```yaml Type: SwitchParameter @@ -533,6 +576,7 @@ Accept wildcard characters: False ``` ### -ExcelWarnOnDataRefresh + Turns off or on the warning dialog displayed when data refreshes in Excel in a browser. ```yaml @@ -548,10 +592,10 @@ Accept wildcard characters: False ``` ### -ExcelWorkbookSizeMax + Specifies the maximum size, in megabytes, of a workbook that can be loaded. -The type must be an integer value in the range of 1 to 2000. -The default value is 10. +The type must be an integer value in the range of 1 to 2000. The default value is 10. ```yaml Type: Int32 @@ -566,8 +610,10 @@ Accept wildcard characters: False ``` ### -ExternalURL + Specifies the URL root that clients use to access the Office Online Server farm from the Internet. -In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to the IP address of the external-facing load balancer. +In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to +the IP address of the external-facing load balancer. An Office Online Server farm requires at least one URL, set using either ExternalURL or InternalURL. You can also set both internal and external URLs. @@ -585,8 +631,10 @@ Accept wildcard characters: False ``` ### -FarmOU -Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of to join the Office Online Server farm. -Use this parameter to prevent unauthorized servers (that is, servers that are not in the OU) from joining an Office Online Server farm. + +Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of +to join the Office Online Server farm. Use this parameter to prevent unauthorized servers (that is, +servers that are not in the OU) from joining an Office Online Server farm. ```yaml Type: String @@ -601,6 +649,7 @@ Accept wildcard characters: False ``` ### -Force + Suppresses any user prompts by answering Yes. ```yaml @@ -616,6 +665,7 @@ Accept wildcard characters: False ``` ### -InternalURL + Specifies the URL root that clients use to access the Office Online Server farm from the intranet. An Office Online Server farm requires at least one URL, set using either ExternalURL or InternalURL. @@ -634,10 +684,11 @@ Accept wildcard characters: False ``` ### -LogLocation + Specifies the location on the local computer where activity logs are stored. The location applies for every server in the farm and cannot be customized on a per-server basis. -The default location is %programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\`. Be sure to allow sufficient disk space on the drive on which logs are stored. @@ -654,11 +705,10 @@ Accept wildcard characters: False ``` ### -LogRetentionInDays -Specifies the number of days that log entries are stored. -Log entries older than the configured date are trimmed. -The type must be an integer value in the range of 0 to 365. -The default value is 7 days. +Specifies the number of days that log entries are stored. Log entries older than the configured date +are trimmed. The type must be an integer value in the range of 0 to 365. The default value is 7 +days. ```yaml Type: UInt32 @@ -673,25 +723,22 @@ Accept wildcard characters: False ``` ### -LogVerbosity -Specifies how much information is stored in the trace log files. -The values are as follows: - -VerboseEX writes low-level detail to the trace log file. -Useful for traces that are likely to be high volume. - -Verbose writes low-level detail to the trace log file. - -Medium writes medium-level detail to the trace log file. - -High writes high-level detail to the trace log file. -Monitorable writes traces that represent an unusual code path and actions that should be monitored. +Specifies how much information is stored in the trace log files. The values are as follows: -Unexpected writes traces that represent an unexpected code path and actions that should be monitored. +- VerboseEX writes low-level detail to the trace log file. Useful for traces that are likely to be + high volume. +- Verbose writes low-level detail to the trace log file. +- Medium writes medium-level detail to the trace log file. +- High writes high-level detail to the trace log file. +- Monitorable writes traces that represent an unusual code path and actions that should be + monitored. +- Unexpected writes traces that represent an unexpected code path and actions that should be + monitored. +- None writes no trace information to the trace log file. -None writes no trace information to the trace log file. - -Leaving the LogVerbosity at a low level for an extended period of time will negatively impact performance. +Leaving the LogVerbosity at a low level for an extended period of time will negatively impact +performance. ```yaml Type: String @@ -706,10 +753,9 @@ Accept wildcard characters: False ``` ### -MaxMemoryCacheSizeInMB -Specifies, in megabytes, the maximum amount of memory that the rendering cache can use. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 75 MB. +Specifies, in megabytes, the maximum amount of memory that the rendering cache can use. The type +must be an integer value in the range of 0 to any positive integer. The default size is 75 MB. ```yaml Type: Int32 @@ -724,11 +770,10 @@ Accept wildcard characters: False ``` ### -MaxTranslationCharacterCount -Specifies the maximum amount of characters a document can have in order to be translated. -The type must be an integer value. -The value can be set to 0 to indicate no limit or a value from 2000 to 2,000,000. -The default value is 125,000. +Specifies the maximum amount of characters a document can have in order to be translated. The type +must be an integer value. The value can be set to 0 to indicate no limit or a value from 2000 to +2,000,000. The default value is 125,000. ```yaml Type: Int32 @@ -743,9 +788,9 @@ Accept wildcard characters: False ``` ### -OpenFromUncEnabled -Turns on or off the ability to use Online Viewers to view Office files from a UNC path. -You must first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths. +Turns on or off the ability to use Online Viewers to view Office files from a UNC path. You must +first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths. ```yaml Type: SwitchParameter @@ -760,10 +805,9 @@ Accept wildcard characters: False ``` ### -OpenFromUrlEnabled -Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path. -The default is False. -You must set this parameter to True when you use ClipartEnabled. +Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path. The +default is False. You must set this parameter to True when you use ClipartEnabled. ```yaml Type: SwitchParameter @@ -778,8 +822,10 @@ Accept wildcard characters: False ``` ### -OpenFromUrlThrottlingEnabled -Throttles the number of Open From URL requests from any given server in a time period. -The default throttling values, which are not configurable, make sure that an Office Online Server farm will not overwhelm a single server with requests for content to be viewed in the Online Viewers. + +Throttles the number of Open From URL requests from any given server in a time period. The default +throttling values, which are not configurable, make sure that an Office Online Server farm will not +overwhelm a single server with requests for content to be viewed in the Online Viewers. ```yaml Type: SwitchParameter @@ -794,9 +840,10 @@ Accept wildcard characters: False ``` ### -PicturePasteDisabled -Turns off the ability for users to paste images from a web page into Office in a browser. -The default is False. -If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to False, users can paste images into Office in a browser. + +Turns off the ability for users to paste images from a web page into Office in a browser. The +default is False. If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to +False, users can paste images into Office in a browser. ```yaml Type: SwitchParameter @@ -811,6 +858,7 @@ Accept wildcard characters: False ``` ### -Proxy + Specifies the URL of the proxy server that is configured to allow HTTP requests to external sites. Typically configured in conjunction with the ClipartEnabled and TranslationEnabled parameters. @@ -827,10 +875,9 @@ Accept wildcard characters: False ``` ### -RecycleActiveProcessCount -Specifies the number of files that a single Word or PowerPoint process can render before the process is recycled. -The type must be an integer value in the range of 1 to 1000. -The default value is 5. +Specifies the number of files that a single Word or PowerPoint process can render before the process +is recycled. The type must be an integer value in the range of 1 to 1000. The default value is 5. ```yaml Type: UInt32 @@ -845,19 +892,17 @@ Accept wildcard characters: False ``` ### -RemovePersonalInformationFromLogs -Provides a best effort scrub of personal information from Office Online Server logs and replaces values with a SHA256 hash. -Potentially scrubbed information can be: - -Document names and URLs - -IP addresses -Email addresses +Provides a best effort scrub of personal information from Office Online Server logs and replaces +values with a SHA256 hash. Potentially scrubbed information can be: -User names +- Document names and URLs +- IP addresses +- Email addresses +- User names -The default is False. -Note that enabling this parameter doesn't guarantee that personal information won't be logged to the Office Online Server logs. +The default is False. Note that enabling this parameter doesn't guarantee that personal information +won't be logged to the Office Online Server logs. ```yaml Type: SwitchParameter @@ -872,9 +917,10 @@ Accept wildcard characters: False ``` ### -RenderingLocalCacheLocation + Specifies the location of the temporary cache for use by the Word and PowerPoint Viewing Services. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\waccache\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Working\waccache\`. ```yaml Type: String @@ -889,7 +935,9 @@ Accept wildcard characters: False ``` ### -S2SCertificateName -The friendly name of the certificate to use for server-to-server authentication with SharePoint Server. + +The friendly name of the certificate to use for server-to-server authentication with SharePoint +Server. ```yaml Type: String @@ -904,9 +952,11 @@ Accept wildcard characters: False ``` ### -SSLOffloaded -Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load balancer. -When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local server. -However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for those references. + +Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load +balancer. When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local +server. However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for +those references. ```yaml Type: SwitchParameter @@ -921,9 +971,11 @@ Accept wildcard characters: False ``` ### -TranslationEnabled -Enables support for automatic document translation using Microsoft Translator, an online service that translates text between languages. -The translated file is shown in Word. -Because Microsoft Translator is an online service, you must enable server-to-web communication directly or by using a proxy that you specify by using the Proxy parameter. + +Enables support for automatic document translation using Microsoft Translator, an online service +that translates text between languages. The translated file is shown in Word. Because Microsoft +Translator is an online service, you must enable server-to-web communication directly or by using a +proxy that you specify by using the Proxy parameter. Microsoft Translator may collect data to improve the quality of translations. @@ -940,9 +992,10 @@ Accept wildcard characters: False ``` ### -TranslationServiceAddress -Specifies the URL of the translation server that translation requests are sent to. -The default is the Microsoft Translator online service. -Typically you will not use this parameter unless you must change translation services. + +Specifies the URL of the translation server that translation requests are sent to. The default is +the Microsoft Translator online service. Typically you will not use this parameter unless you must +change translation services. ```yaml Type: String @@ -957,9 +1010,11 @@ Accept wildcard characters: False ``` ### -TranslationServiceAppId -Specifies the application ID for the translation service. -The default is the public application ID for Office in a browser. -Typically you will not use this parameter unless you have negotiated with Microsoft Translator for additional services and they have provided you with a private application ID. + +Specifies the application ID for the translation service. The default is the public application ID +for Office in a browser. Typically you will not use this parameter unless you have negotiated with +Microsoft Translator for additional services and they have provided you with a private application +ID. ```yaml Type: String @@ -974,8 +1029,9 @@ Accept wildcard characters: False ``` ### -WhatIf -Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters + +Displays a message that describes the effect of the command instead of executing the command. For +more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md index 4a20df4902..a0f6c9701d 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsHost ## SYNOPSIS + Adds a host domain to the Allow List for an Office Online Server farm. ## SYNTAX @@ -21,35 +22,41 @@ New-OfficeWebAppsHost -Domain ``` ## DESCRIPTION -The New-OfficeWebAppsHost cmdlet adds a host domain to the list of host domains to which Office Online Server allows file operations requests, such as file retrieval, metadata retrieval, and file changes. -This list, known as the Allow List, is a security feature that prevents unwanted hosts from connecting to an Office Online Server farm and using it for file operations without your knowledge. -You may any domain type including: Public, Pool, Farm, and Active Directory domain names. -Just make sure that the domain you're granting access to meets your security requirements. +The New-OfficeWebAppsHost cmdlet adds a host domain to the list of host domains to which Office +Online Server allows file operations requests, such as file retrieval, metadata retrieval, and file +changes. This list, known as the Allow List, is a security feature that prevents unwanted hosts from +connecting to an Office Online Server farm and using it for file operations without your knowledge. + +You may any domain type including: Public, Pool, Farm, and Active Directory domain names. Just make +sure that the domain you're granting access to meets your security requirements. -The wildcard * is assumed for any domain that is added to the Allow List so that requests to all subdomains are also allowed. -For example, if you add the domain contoso.com to the Allow List, Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. +The wildcard * is assumed for any domain that is added to the Allow List so that requests to all +subdomains are also allowed. For example, if you add the domain contoso.com to the Allow List, +Office Online Server also allows requests to the domains corp.contoso.com and dev.contoso.com. Requests to other domains (such as fabrikam.com) are not allowed. -If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any domain. -Do not leave this list blank if your Office Online Server farm is accessible from the Internet. -Otherwise anyone can use your Office Online Server farm to view and edit content. +If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any +domain. Do not leave this list blank if your Office Online Server farm is accessible from the +Internet. Otherwise anyone can use your Office Online Server farm to view and edit content. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell New-OfficeWebAppsHost -domain "contoso.com" ``` This example adds the domain contoso.com to the Allow List. -You cannot add multiple host domains to the Allow List all at the same time. -You must run the New-OfficeWebAppsHost cmdlet for each host domain that you want to add to the Allow List. +You cannot add multiple host domains to the Allow List all at the same time. You must run the +New-OfficeWebAppsHost cmdlet for each host domain that you want to add to the Allow List. ## PARAMETERS ### -Domain + Specifies the domain to add to the Allow List. Do not specify an asterisk or start it with a period. diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md index 7499d63f1c..a3fe411c10 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # New-OfficeWebAppsMachine ## SYNOPSIS + Adds the current server to an existing Office Online Server farm. ## SYNTAX @@ -21,20 +22,25 @@ New-OfficeWebAppsMachine [-Force] [-MachineToJoin] [-Roles ] ``` ## DESCRIPTION -The New-OfficeWebAppsMachine cmdlet adds the current server to an existing Office Online Server farm and optionally sets one or more roles on the new server. + +The New-OfficeWebAppsMachine cmdlet adds the current server to an existing Office Online Server farm +and optionally sets one or more roles on the new server. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell New-OfficeWebAppsMachine -MachineToJoin server1.contoso.com ``` -This example adds the current server to the Office Online Server farm that is running on the server named server1.contoso.com. +This example adds the current server to the Office Online Server farm that is running on the server +named server1.contoso.com. ## PARAMETERS ### -MachineToJoin + Specifies the name of any server that is already a member of the Office Online Server farm. ```yaml @@ -50,8 +56,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -66,6 +72,7 @@ Accept wildcard characters: False ``` ### -Force + Assumes the answer to any user prompt is Yes. ```yaml @@ -81,18 +88,16 @@ Accept wildcard characters: False ``` ### -Roles -Specifies one or more server roles, separated by commas, to assign to the new server. -If no roles are specified, then the server is assigned all roles. - -The role types are as follows: -FrontEnd +Specifies one or more server roles, separated by commas, to assign to the new server. If no roles +are specified, then the server is assigned all roles. -WordBackEnd - -ExcelBackEnd +The role types are as follows: -PowerPointBackEnd +- FrontEnd +- WordBackEnd +- ExcelBackEnd +- PowerPointBackEnd As a best practice, we recommend that all servers in an Office Online Server farm run all roles. Assigning roles is not useful until the Office Online Server farm contains approximately 50 servers. @@ -110,8 +115,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md index a77ac79a21..3c771412ea 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelBIServer.md @@ -12,7 +12,9 @@ ms.reviewer: # Remove-OfficeWebAppsExcelBIServer ## SYNOPSIS -Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel Online. + +Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel +Online. ## SYNTAX @@ -21,24 +23,30 @@ Remove-OfficeWebAppsExcelBIServer -ServerId ``` ## DESCRIPTION -Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel Online. + +Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel +Online. ## EXAMPLES -### This example removes the server named SSAS01 from the Allow List. -``` +### Example 1 + +This example removes the server named SSAS01 from the Allow List. + +```powershell Remove-OfficeWebAppsExcelBIServer -ServerID "SSAS01" ``` ## PARAMETERS ### -ServerId + The name of the Analysis Services server. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md index 6fb132b9ed..2548862222 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # Remove-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Removes an existing UDF definition. ## SYNTAX @@ -21,24 +22,29 @@ Remove-OfficeWebAppsExcelUserDefinedFunction [-Identity] [ ``` ## DESCRIPTION + Removes an existing UDF definition. ## EXAMPLES -### This example removes the UDF c:\myudf.dll. -``` +### Example 1 + +This example removes the UDF c:\myudf.dll. + +```powershell Remove-OfficeWebAppsExcelUserDefinedFunction -Identity c:\myudf.dll ``` ## PARAMETERS ### -Identity + The path and filename of the UDF. ```yaml Type: UserDefinedFunction Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -48,8 +54,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -64,8 +70,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md index f1e314a029..bf5d6e8f6c 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsHost.md @@ -12,6 +12,7 @@ ms.reviewer: # Remove-OfficeWebAppsHost ## SYNOPSIS + Removes a host domain from the Allow List for an Office Online Server farm. ## SYNTAX @@ -21,17 +22,19 @@ Remove-OfficeWebAppsHost -Domain ``` ## DESCRIPTION -The Remove-OfficeWebAppsHost cmdlet removes the specified host domain from the Allow List. -The Allow List contains the host domains to which Office Online Server allows file operations requests. -If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any domain. -Do not leave this list blank if your Office Online Server farm is accessible from the Internet. -Otherwise anyone can use your Office Online Server farm to view and edit content. +The Remove-OfficeWebAppsHost cmdlet removes the specified host domain from the Allow List. The Allow +List contains the host domains to which Office Online Server allows file operations requests. + +If there are no domains on the Allow List, Office Online Server allows file requests to hosts in any +domain. Do not leave this list blank if your Office Online Server farm is accessible from the +Internet. Otherwise anyone can use your Office Online Server farm to view and edit content. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Remove-OfficeWebAppsHost -domain "contoso.com" ``` @@ -40,6 +43,7 @@ This example removes the domain contoso.com from the Allow List. ## PARAMETERS ### -Domain + Specifies the host domain to remove from the Allow List. ```yaml diff --git a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md index 2abe880dfe..1b256e19b4 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Remove-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # Remove-OfficeWebAppsMachine ## SYNOPSIS + Removes the current server from the Office Online Server farm. ## SYNTAX @@ -21,16 +22,22 @@ Remove-OfficeWebAppsMachine [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The Remove-OfficeWebAppsMachine cmdlet removes the current server from the Office Online Server farm. -As part of this process, the cmdlet removes the web applications and shuts down the services that are related to Office Online Server. -If you cannot run the Remove-OfficeWebAppsMachine cmdlet from the server that you want to remove, use the Repair-OfficeWebAppsFarm cmdlet from any other server in the Office Online farm. -If the local server is designated as the master server in the Office Online Server farm, you cannot remove it from the farm until you assign a different server as master by using the Set-OfficeWebAppsMachine cmdlet, or until you remove all other servers from the farm. +The Remove-OfficeWebAppsMachine cmdlet removes the current server from the Office Online Server +farm. As part of this process, the cmdlet removes the web applications and shuts down the services +that are related to Office Online Server. If you cannot run the Remove-OfficeWebAppsMachine cmdlet +from the server that you want to remove, use the Repair-OfficeWebAppsFarm cmdlet from any other +server in the Office Online farm. + +If the local server is designated as the master server in the Office Online Server farm, you cannot +remove it from the farm until you assign a different server as master by using the +Set-OfficeWebAppsMachine cmdlet, or until you remove all other servers from the farm. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Remove-OfficeWebAppsMachine ``` @@ -39,8 +46,8 @@ This example removes the current server from the Office Online Server farm. ## PARAMETERS ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -55,8 +62,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md index e2f822e3bb..b30252119d 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md @@ -12,6 +12,7 @@ ms.reviewer: # Repair-OfficeWebAppsFarm ## SYNOPSIS + Removes all servers flagged as unhealthy from an Office Online Server farm. ## SYNTAX @@ -21,25 +22,30 @@ Repair-OfficeWebAppsFarm [-Force] [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The Repair-OfficeWebAppsFarm cmdlet removes all servers flagged as unhealthy from an Office Online Server farm. -This cmdlet updates the farm topology but does not clean up services and web applications on the servers that are removed. -For this reason, we recommend making every effort to run the Remove-OfficeWebAppsMachine cmdlet from the unhealthy servers so that they are cleanly removed from the farm. -Use the Repair-OfficeWebAppsFarm cmdlet only if the unhealthy servers have failed and you cannot run the Remove-OfficeWebAppsMachine cmdlet directly on them. -If there are multiple unhealthy servers, you are prompted before each server is removed. -If there are no unhealthy servers, this cmdlet does nothing. +The Repair-OfficeWebAppsFarm cmdlet removes all servers flagged as unhealthy from an Office Online +Server farm. This cmdlet updates the farm topology but does not clean up services and web +applications on the servers that are removed. For this reason, we recommend making every effort to +run the Remove-OfficeWebAppsMachine cmdlet from the unhealthy servers so that they are cleanly +removed from the farm. Use the Repair-OfficeWebAppsFarm cmdlet only if the unhealthy servers have +failed and you cannot run the Remove-OfficeWebAppsMachine cmdlet directly on them. + +If there are multiple unhealthy servers, you are prompted before each server is removed. If there +are no unhealthy servers, this cmdlet does nothing. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell (Get-OfficeWebAppsFarm).Machines ``` This example displays the health status of all servers in the Office Online Server farm. ### EXAMPLE 2 -``` + +```powershell Repair-OfficeWebAppsFarm ``` @@ -48,8 +54,8 @@ This example removes all unhealthy servers from the Office Online Server farm. ## PARAMETERS ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -64,6 +70,7 @@ Accept wildcard characters: False ``` ### -Force + Assumes the answer to any user prompt is Yes. ```yaml @@ -79,8 +86,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md index 3f8b966834..cdbf52285b 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsExcelUserDefinedFunction.md @@ -12,6 +12,7 @@ ms.reviewer: # Set-OfficeWebAppsExcelUserDefinedFunction ## SYNOPSIS + Sets properties on existing UDF definitions. ## SYNTAX @@ -22,24 +23,29 @@ Set-OfficeWebAppsExcelUserDefinedFunction [-Identity] [-As ``` ## DESCRIPTION + Sets properties on existing UDF definitions. ## EXAMPLES -### This example disables the UDF at c:\myudf.dll. -``` +### Example 1 + +This example disables the UDF at c:\myudf.dll. + +```powershell Set-OfficeWebAppsExcelUserDefinedFunction -Identity c:\myudf.dll -Enable:$false ``` ## PARAMETERS ### -Identity + The path and filename of the UDF. ```yaml Type: UserDefinedFunction Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -49,12 +55,13 @@ Accept wildcard characters: False ``` ### -Assembly + The name of the assembly. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -64,13 +71,18 @@ Accept wildcard characters: False ``` ### -AssemblyLocation + The location of the assembly. -Values: LocalFile - a local directory; GAC - the Global Assembly Cache. + +Values: + +- LocalFile - a local directory +- GAC - the Global Assembly Cache ```yaml Type: AssemblyLocation Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -80,8 +92,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -96,12 +108,13 @@ Accept wildcard characters: False ``` ### -Description + A description of the assembly. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -111,12 +124,13 @@ Accept wildcard characters: False ``` ### -Enable + Enables the UDF. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -126,8 +140,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md index 9f29a6748d..68a1b316c3 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsFarm.md @@ -12,51 +12,58 @@ ms.reviewer: # Set-OfficeWebAppsFarm ## SYNOPSIS + Configures the settings of an existing Office Online Server farm. ## SYNTAX ``` -Set-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] [-AllowHttp] - [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] [-S2SCertificateName ] - [-EditingEnabled] [-Proxy ] [-LogLocation ] [-LogRetentionInDays ] - [-LogVerbosity ] [-CacheLocation ] [-MaxMemoryCacheSizeInMB ] - [-DocumentInfoCacheSize ] [-CacheSizeInGB ] [-ClipartEnabled] [-TranslationEnabled] - [-MaxTranslationCharacterCount ] [-TranslationServiceAppId ] - [-TranslationServiceAddress ] [-RenderingLocalCacheLocation ] - [-RecycleActiveProcessCount ] [-AllowCEIP] [-ExcelRequestDurationMax ] - [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] [-ExcelPrivateBytesMax ] - [-ExcelConnectionLifetime ] [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] - [-ExcelUseEffectiveUserName] [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] - [-ExcelMemoryCacheThreshold ] [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] - [-ExcelAbortOnRefreshOnOpenFail] [-ExcelAutomaticVolatileFunctionCacheLifeTime ] - [-ExcelConcurrentDataRequestsPerSessionMax ] [-ExcelDefaultWorkbookCalcMode ] - [-ExcelRestExternalDataEnabled] [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] - [-OpenFromUncEnabled] [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] - [-RemovePersonalInformationFromLogs] [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] +Set-OfficeWebAppsFarm [-Force] [-FarmOU ] [-InternalURL ] [-ExternalURL ] + [-AllowHttp] [-AllowOutboundHttp] [-SSLOffloaded] [-CertificateName ] + [-S2SCertificateName ] [-EditingEnabled] [-Proxy ] [-LogLocation ] + [-LogRetentionInDays ] [-LogVerbosity ] [-CacheLocation ] + [-MaxMemoryCacheSizeInMB ] [-DocumentInfoCacheSize ] [-CacheSizeInGB ] + [-ClipartEnabled] [-TranslationEnabled] [-MaxTranslationCharacterCount ] + [-TranslationServiceAppId ] [-TranslationServiceAddress ] + [-RenderingLocalCacheLocation ] [-RecycleActiveProcessCount ] [-AllowCEIP] + [-ExcelRequestDurationMax ] [-ExcelSessionTimeout ] [-ExcelWorkbookSizeMax ] + [-ExcelPrivateBytesMax ] [-ExcelConnectionLifetime ] + [-ExcelExternalDataCacheLifetime ] [-ExcelAllowExternalData] [-ExcelUseEffectiveUserName] + [-ExcelWarnOnDataRefresh] [-ExcelUdfsAllowed] [-ExcelMemoryCacheThreshold ] + [-ExcelUnusedObjectAgeMax ] [-ExcelCachingUnusedFiles] [-ExcelAbortOnRefreshOnOpenFail] + [-ExcelAutomaticVolatileFunctionCacheLifeTime ] + [-ExcelConcurrentDataRequestsPerSessionMax ] + [-ExcelDefaultWorkbookCalcMode ] [-ExcelRestExternalDataEnabled] + [-ExcelChartAndImageSizeMax ] [-OpenFromUrlEnabled] [-OpenFromUncEnabled] + [-OpenFromUrlThrottlingEnabled] [-PicturePasteDisabled] [-RemovePersonalInformationFromLogs] + [-AllowHttpSecureStoreConnections] [-WhatIf] [-Confirm] ``` ## DESCRIPTION + The Set-OfficeWebAppsFarm cmdlet configures the settings of an existing Office Online Server farm. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Set-OfficeWebAppsFarm -ClipartEnabled:$true ``` This example enables insertion of clip art from Office.com. ### EXAMPLE 2 -``` + +```powershell Set-OfficeWebAppsFarm -EditingEnabled:$true ``` This example enables edit functionality for Office in a browser. ### EXAMPLE 3 -``` + +```powershell Set-OfficeWebAppsFarm -OpenFromUncEnabled:$false ``` @@ -65,7 +72,9 @@ This example turns off the ability to view any Office file from a UNC path. ## PARAMETERS ### -AllowCEIP -Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online Server farm. + +Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online +Server farm. You must restart every server in the Office Online Server farm for this change to take effect. @@ -82,8 +91,10 @@ Accept wildcard characters: False ``` ### -AllowHttp -Indicates that IIS sites should be provisioned on port 80 for HTTP access. -Use AllowHTTP only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. + +Indicates that IIS sites should be provisioned on port 80 for HTTP access. Use AllowHTTP only in +environments where all computers require IPSEC (full encryption) or in test environments that do not +contain sensitive files. Enabled automatically when you enable SSLOffloaded. @@ -102,10 +113,12 @@ Accept wildcard characters: False ``` ### -AllowHttpSecureStoreConnections -Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). -The default is False. -Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files. +Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). The +default is False. + +Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full +encryption) or in test environments that do not contain sensitive files. ```yaml Type: SwitchParameter @@ -120,6 +133,7 @@ Accept wildcard characters: False ``` ### -AllowOutboundHttp + Allows outbound HTTP connections from Office Online Server. ```yaml @@ -135,8 +149,9 @@ Accept wildcard characters: False ``` ### -CacheLocation + Specifies the location of the global disk cache that is used to store rendered image files. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\d\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Working\d\`. ```yaml Type: String @@ -151,10 +166,9 @@ Accept wildcard characters: False ``` ### -CacheSizeInGB -Specifies the maximum size of the global disk cache in gigabytes. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 15 GB. +Specifies the maximum size of the global disk cache in gigabytes. The type must be an integer value +in the range of 0 to any positive integer. The default size is 15 GB. ```yaml Type: Int32 @@ -169,14 +183,18 @@ Accept wildcard characters: False ``` ### -CertificateName -Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS bindings. -If the specified certificate is not found or has expired, or if the specified value is associated with more than one certificate, an error is logged and the farm is not created. +Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS +bindings. -This value is used on every server that joins the Office Online Server farm. -Therefore, every server in the farm must have a certificate that has this friendly name. +If the specified certificate is not found or has expired, or if the specified value is associated +with more than one certificate, an error is logged and the farm is not created. -You don't have to specify the CertificateName parameter if you are using either the AllowHttp or SSLOffloaded parameter. +This value is used on every server that joins the Office Online Server farm. Therefore, every server +in the farm must have a certificate that has this friendly name. + +You don't have to specify the CertificateName parameter if you are using either the AllowHttp or +SSLOffloaded parameter. You must restart every server in the farm for this change to take effect. @@ -193,8 +211,10 @@ Accept wildcard characters: False ``` ### -ClipartEnabled -Enables support for inserting clip art from Office.com into Office documents. -This feature requires server-to-web communication, configured either directly or by using a proxy that you specify by using the Proxy parameter. + +Enables support for inserting clip art from Office.com into Office documents. This feature requires +server-to-web communication, configured either directly or by using a proxy that you specify by +using the Proxy parameter. ```yaml Type: SwitchParameter @@ -209,8 +229,8 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters. ```yaml Type: SwitchParameter @@ -225,6 +245,7 @@ Accept wildcard characters: False ``` ### -DocumentInfoCacheSize + Specifies the maximum number of document conversion records that are stored in a memory cache. The default value is 5000 records. @@ -242,9 +263,9 @@ Accept wildcard characters: False ``` ### -EditingEnabled -Enables support for editing in the browser. -The default is False. -Only set to True if you have the appropriate licensing to use the edit functionality. + +Enables support for editing in the browser. The default is False. Only set to True if you have the +appropriate licensing to use the edit functionality. ```yaml Type: SwitchParameter @@ -259,8 +280,9 @@ Accept wildcard characters: False ``` ### -ExcelAbortOnRefreshOnOpenFail -Prevents a workbook from loading if data refresh fails. -This helps prevent users from seeing out-of-date information or possibly information that they should not have access to. + +Prevents a workbook from loading if data refresh fails. This helps prevent users from seeing +out-of-date information or possibly information that they should not have access to. ```yaml Type: SwitchParameter @@ -275,8 +297,9 @@ Accept wildcard characters: False ``` ### -ExcelAllowExternalData -Enables the refresh of supported external data in Excel workbooks in a browser where workbooks contain connections to external data. -The default is True. + +Enables the refresh of supported external data in Excel workbooks in a browser where workbooks +contain connections to external data. The default is True. ```yaml Type: SwitchParameter @@ -291,10 +314,13 @@ Accept wildcard characters: False ``` ### -ExcelAutomaticVolatileFunctionCacheLifeTime -Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. --1: Calculates once when the workbook loads. -0: Always calculates. -1 to 2073600: Caches 1 second to 24 days. + +Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for +automatic recalculations. + +- -1: Calculates once when the workbook loads. +- 0: Always calculates. +- 1 to 2073600: Caches 1 second to 24 days. ```yaml Type: Int32 @@ -309,6 +335,7 @@ Accept wildcard characters: False ``` ### -ExcelCachingUnusedFiles + Enable caching of files that are no longer in use by Web Excel sessions. ```yaml @@ -324,8 +351,9 @@ Accept wildcard characters: False ``` ### -ExcelChartAndImageSizeMax -Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a browser. -The value must be an integer greater than 0. + +Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a +browser. The value must be an integer greater than 0. ```yaml Type: Int32 @@ -340,8 +368,9 @@ Accept wildcard characters: False ``` ### -ExcelConcurrentDataRequestsPerSessionMax -Specifies the maximum number of concurrent external data requests allowed in each session. -If a session must issue more than this number of requests, additional requests are queued. + +Specifies the maximum number of concurrent external data requests allowed in each session. If a +session must issue more than this number of requests, additional requests are queued. ```yaml Type: Int32 @@ -356,8 +385,9 @@ Accept wildcard characters: False ``` ### -ExcelConnectionLifetime -Specifies the duration, in seconds, of external data connections for Excel in a browser. -The default is 1800 seconds. + +Specifies the duration, in seconds, of external data connections for Excel in a browser. The default +is 1800 seconds. ```yaml Type: Int32 @@ -372,6 +402,7 @@ Accept wildcard characters: False ``` ### -ExcelDefaultWorkbookCalcMode + PARAMVALUE: File | Manual | Auto | AutoDataTables ```yaml @@ -387,8 +418,9 @@ Accept wildcard characters: False ``` ### -ExcelExternalDataCacheLifetime -Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. -The default is 300 seconds. + +Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. The +default is 300 seconds. ```yaml Type: Int32 @@ -403,9 +435,10 @@ Accept wildcard characters: False ``` ### -ExcelMemoryCacheThreshold -The percentage of the Maximum Private Bytes that can be allocated to inactive objects. -When the memory cache threshold is exceeded, cached objects that are not currently in use are released. -Valid values: 0 (disables caching of inactive objects); from 1 through 95. + +The percentage of the Maximum Private Bytes that can be allocated to inactive objects. When the +memory cache threshold is exceeded, cached objects that are not currently in use are released. Valid +values: 0 (disables caching of inactive objects); from 1 through 95. ```yaml Type: Int32 @@ -420,11 +453,11 @@ Accept wildcard characters: False ``` ### -ExcelPrivateBytesMax -Specifies the maximum private bytes, in megabytes, used by Excel in a browser. -When set to -1, the maximum private bytes use 50 percent of physical memory on the computer. -The type must be -1 or any positive integer. -The default value is -1. +Specifies the maximum private bytes, in megabytes, used by Excel in a browser. When set to -1, the +maximum private bytes use 50 percent of physical memory on the computer. + +The type must be -1 or any positive integer. The default value is -1. You must restart every server in the farm for this change to take effect. @@ -441,11 +474,11 @@ Accept wildcard characters: False ``` ### -ExcelRequestDurationMax -Specifies the maximum duration, in seconds, for a single request in a session. -After this time elapses, the request times out. -The type must be -1 (no limit) or an integer in the range of 1 to 2073600. -The default value is 300. +Specifies the maximum duration, in seconds, for a single request in a session. After this time +elapses, the request times out. + +The type must be -1 (no limit) or an integer in the range of 1 to 2073600. The default value is 300. ```yaml Type: Int32 @@ -460,10 +493,9 @@ Accept wildcard characters: False ``` ### -ExcelRestExternalDataEnabled -Allow requests from the REST API to refresh external data connections. -This setting has no effect if Allow External Data is set to None. -Check box Bool. -Default is False. + +Allow requests from the REST API to refresh external data connections. This setting has no effect if +Allow External Data is set to None. Check box Bool. Default is False. ```yaml Type: SwitchParameter @@ -478,14 +510,14 @@ Accept wildcard characters: False ``` ### -ExcelSessionTimeout -Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no user activity. -Valid values include the following: --1 Session never expires. +Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no +user activity. Valid values include the following: -0 Session expires at the end of a single request. +- -1 Session never expires. +- 0 Session expires at the end of a single request. +- 1 to 2073600 Session remains active for 1 second to 24 days. -1 to 2073600 Session remains active for 1 second to 24 days. The default value is 450. ```yaml @@ -501,8 +533,8 @@ Accept wildcard characters: False ``` ### -ExcelUdfsAllowed -Enables User Defined Functions for Excel in a browser. -The default is False. + +Enables User Defined Functions for Excel in a browser. The default is False. ```yaml Type: SwitchParameter @@ -517,9 +549,15 @@ Accept wildcard characters: False ``` ### -ExcelUnusedObjectAgeMax -The maximum time (in minutes) that inactive objects remain in the memory cache. -Inactive objects are objects that are not used in a session. -Valid values: -1 (no maximum); from 1 through 34560 (24 days). + +The maximum time (in minutes) that inactive objects remain in the memory cache. Inactive objects are +objects that are not used in a session. + +Valid values: + +- -1 (no maximum) +- 1 through 34560 (24 days). + Default is -1. ```yaml @@ -535,8 +573,9 @@ Accept wildcard characters: False ``` ### -ExcelUseEffectiveUserName -Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. -The default is False. + +Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. The +default is False. ```yaml Type: SwitchParameter @@ -551,6 +590,7 @@ Accept wildcard characters: False ``` ### -ExcelWarnOnDataRefresh + Turns off or on the warning dialog box that is displayed when data refreshes in Excel in a browser. ```yaml @@ -566,10 +606,10 @@ Accept wildcard characters: False ``` ### -ExcelWorkbookSizeMax + Specifies the maximum size, in megabytes, of a workbook that can be loaded. -The type must be an integer value in the range of 1 to 2000. -The default value is 10. +The type must be an integer value in the range of 1 to 2000. The default value is 10. ```yaml Type: Int32 @@ -584,11 +624,13 @@ Accept wildcard characters: False ``` ### -ExternalURL + Specifies the URL root that clients use to access the Office Online Server farm from the Internet. -In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to the IP address of the external-facing load balancer. +In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to +the IP address of the external-facing load balancer. -An Office Online Server farm requires at least one URL,that isset by using either ExternalURL or InternalURL. -You can also set both internal and external URLs. +An Office Online Server farm requires at least one URL,that isset by using either ExternalURL or +InternalURL. You can also set both internal and external URLs. ```yaml Type: String @@ -603,8 +645,10 @@ Accept wildcard characters: False ``` ### -FarmOU -Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of to join the Office Online Server farm. -Use this parameter to prevent unauthorized servers (that is, servers that are not in the OU) from joining an Office Online Server farm. + +Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of +to join the Office Online Server farm. Use this parameter to prevent unauthorized servers (that is, +servers that are not in the OU) from joining an Office Online Server farm. ```yaml Type: String @@ -619,6 +663,7 @@ Accept wildcard characters: False ``` ### -Force + Suppresses any user prompts by answering "Yes." ```yaml @@ -634,11 +679,12 @@ Accept wildcard characters: False ``` ### -InternalURL -Specifies the URL root that clients must use to access the Office Online Server farm from the intranet. -An Office Online Server farm requires at least one URL. -It is set using either ExternalURL or InternalURL. -You can also set both internal and external URLs. +Specifies the URL root that clients must use to access the Office Online Server farm from the +intranet. + +An Office Online Server farm requires at least one URL. It is set using either ExternalURL or +InternalURL. You can also set both internal and external URLs. ```yaml Type: String @@ -653,10 +699,11 @@ Accept wildcard characters: False ``` ### -LogLocation + Specifies the location on the local computer where activity logs are stored. The location applies for every server in the farm and cannot be customized on a per-server basis. -The default location is %programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\`. Be sure to allow sufficient disk space on the drive where logs are stored. @@ -675,11 +722,11 @@ Accept wildcard characters: False ``` ### -LogRetentionInDays -Specifies the number of days that log entries are stored. -Log entries older than the configured date are trimmed. -The type must be an integer value in the range of 0 to 365. -The default value is 7 days. +Specifies the number of days that log entries are stored. Log entries older than the configured date +are trimmed. + +The type must be an integer value in the range of 0 to 365. The default value is 7 days. You must restart every server in the farm for this change to take effect. @@ -696,23 +743,19 @@ Accept wildcard characters: False ``` ### -LogVerbosity -Specifies how much information is stored in the trace log files. -The values are as follows: - -VerboseEX writes low-level detail to the trace log file. -Useful for traces that are likely to be high volume. - -Verbose writes low-level detail to the trace log file. - -Medium writes medium-level detail to the trace log file. - -High writes high-level detail to the trace log file. - -Monitorable writes traces that represent an unusual code path and actions that should be monitored. -Unexpected writes traces that represent an unexpected code path and actions that should be monitored. +Specifies how much information is stored in the trace log files. The values are as follows: -None writes no trace information to the trace log file. +- VerboseEX writes low-level detail to the trace log file. Useful for traces that are likely to be + high volume. +- Verbose writes low-level detail to the trace log file. +- Medium writes medium-level detail to the trace log file. +- High writes high-level detail to the trace log file. +- Monitorable writes traces that represent an unusual code path and actions that should be + monitored. +- Unexpected writes traces that represent an unexpected code path and actions that should be + monitored. +- None writes no trace information to the trace log file. Leaving the LogVerbosity at a low level for a long time will adversely affect performance. @@ -731,10 +774,11 @@ Accept wildcard characters: False ``` ### -MaxMemoryCacheSizeInMB + Specifies, in megabytes, the maximum amount of memory that the rendering cache can use. -The type must be an integer value in the range of 0 to any positive integer. -The default size is 1024 MB. +The type must be an integer value in the range of 0 to any positive integer. The default size is +1024 MB. ```yaml Type: Int32 @@ -749,11 +793,11 @@ Accept wildcard characters: False ``` ### -MaxTranslationCharacterCount + Specifies the maximum number of characters a document can have in order to be translated. -The type must be an integer value. -The value can be set to 0 to indicate no limit or a value from 2000 to 2,000,000. -The default value is 125,000. +The type must be an integer value. The value can be set to 0 to indicate no limit or a value from +2000 to 2,000,000. The default value is 125,000. ```yaml Type: Int32 @@ -768,6 +812,7 @@ Accept wildcard characters: False ``` ### -OpenFromUncEnabled + Turns on or off the ability to use Online Viewers to view Office files from a UNC path. You must first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths. @@ -785,6 +830,7 @@ Accept wildcard characters: False ``` ### -OpenFromUrlEnabled + Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path. ```yaml @@ -800,8 +846,10 @@ Accept wildcard characters: False ``` ### -OpenFromUrlThrottlingEnabled -Throttles the number of Open From URL requests from any given server in a time period. -The default throttling values, which are not configurable, make sure that an Office Online Server farm will not overwhelm a single server with requests for content to be viewed in the Online Viewers. + +Throttles the number of Open From URL requests from any given server in a time period. The default +throttling values, which are not configurable, make sure that an Office Online Server farm will not +overwhelm a single server with requests for content to be viewed in the Online Viewers. ```yaml Type: SwitchParameter @@ -816,9 +864,10 @@ Accept wildcard characters: False ``` ### -PicturePasteDisabled -Turns off the ability for users to paste images from a web page into Office in a browser. -The default is False. -If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to False, users can paste images into Office in a browser. + +Turns off the ability for users to paste images from a web page into Office in a browser. The +default is False. If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to +False, users can paste images into Office in a browser. ```yaml Type: SwitchParameter @@ -833,6 +882,7 @@ Accept wildcard characters: False ``` ### -Proxy + Specifies the URL of the proxy server that is configured to allow HTTP requests to external sites. Typically configured together with the ClipartEnabled and TranslationEnabled parameters. @@ -849,10 +899,9 @@ Accept wildcard characters: False ``` ### -RecycleActiveProcessCount -Specifies the number of files that a single Word or PowerPoint process can render before the process is recycled. -The type must be an integer value in the range of 1 to 1000. -The default value is 5. +Specifies the number of files that a single Word or PowerPoint process can render before the process +is recycled. The type must be an integer value in the range of 1 to 1000. The default value is 5. You must restart every server in the farm for this change to take effect. @@ -869,19 +918,17 @@ Accept wildcard characters: False ``` ### -RemovePersonalInformationFromLogs -Provides a best effort scrub of personal information from Office Online Server logs and replaces values with a SHA256 hash. -Potentially scrubbed information can be: - -Document names and URLs -IP addresses +Provides a best effort scrub of personal information from Office Online Server logs and replaces +values with a SHA256 hash. Potentially scrubbed information can be: -Email addresses +- Document names and URLs +- IP addresses +- Email addresses +- User names -User names - -The default is False. -Note that enabling this parameter doesn't guarantee that personal information won't be logged to the Office Online Server logs. +The default is False. Note that enabling this parameter doesn't guarantee that personal information +won't be logged to the Office Online Server logs. ```yaml Type: SwitchParameter @@ -896,9 +943,10 @@ Accept wildcard characters: False ``` ### -RenderingLocalCacheLocation + Specifies the location of the temporary cache for use by the Word and PowerPoint Viewing Services. -The default location is %programdata%\Microsoft\OfficeWebApps\Working\waccache\. +The default location is `%programdata%\Microsoft\OfficeWebApps\Working\waccache\`. ```yaml Type: String @@ -913,7 +961,9 @@ Accept wildcard characters: False ``` ### -S2SCertificateName -The friendly name of the certificate to use for server-to-server authentication with SharePoint Server. + +The friendly name of the certificate to use for server-to-server authentication with SharePoint +Server. ```yaml Type: String @@ -928,9 +978,11 @@ Accept wildcard characters: False ``` ### -SSLOffloaded -Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load balancer. -When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local server. -However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for those references. + +Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load +balancer. When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local +server. However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for +those references. You must restart every server in the farm for this change to take effect. @@ -947,9 +999,11 @@ Accept wildcard characters: False ``` ### -TranslationEnabled -Enables support for automatic document translation using Microsoft Translator, an online service that translates text between languages. -The translated file is shown in Word. -Because Microsoft Translator is an online service, you must enable server-to-web communication directly or by using a proxy that you specify by using the Proxy parameter. + +Enables support for automatic document translation using Microsoft Translator, an online service +that translates text between languages. The translated file is shown in Word. Because Microsoft +Translator is an online service, you must enable server-to-web communication directly or by using a +proxy that you specify by using the Proxy parameter. Microsoft Translator may collect data to improve the quality of translations. @@ -966,9 +1020,10 @@ Accept wildcard characters: False ``` ### -TranslationServiceAddress -Specifies the URL of the translation server that translation requests are sent to. -The default is the Microsoft Translator online service. -Typically you will not use this parameter unless you must change translation services. + +Specifies the URL of the translation server that translation requests are sent to. The default is +the Microsoft Translator online service. Typically you will not use this parameter unless you must +change translation services. You must restart every server in the Office Online Server farm for this change to take effect. @@ -985,9 +1040,11 @@ Accept wildcard characters: False ``` ### -TranslationServiceAppId -Specifies the application ID for the translation service. -The default is the public application ID for Office in a browser. -Typically you will not use this parameter unless you have negotiated with Microsoft Translator for additional services and they have provided you with a private application ID. + +Specifies the application ID for the translation service. The default is the public application ID +for Office in a browser. Typically you will not use this parameter unless you have negotiated with +Microsoft Translator for additional services and they have provided you with a private application +ID. ```yaml Type: String @@ -1002,8 +1059,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md index 80b34fc95b..8ecdea8977 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Set-OfficeWebAppsMachine.md @@ -12,6 +12,7 @@ ms.reviewer: # Set-OfficeWebAppsMachine ## SYNOPSIS + Changes the settings of the current server that is in an Office Online Server farm. ## SYNTAX @@ -21,27 +22,32 @@ Set-OfficeWebAppsMachine [-Master ] [-Roles ] [-WhatIf] [-Conf ``` ## DESCRIPTION -The Set-OfficeWebAppsMachine cmdlet changes the settings of the current server that is in an Office Online Server farm. -The settings include the roles held by the current server and the designated master server for the farm. + +The Set-OfficeWebAppsMachine cmdlet changes the settings of the current server that is in an Office +Online Server farm. The settings include the roles held by the current server and the designated +master server for the farm. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell (Get-OfficeWebAppsFarm).Machines ``` This example shows the roles held by each server in the Office Online Server farm. ### EXAMPLE 2 -``` + +```powershell Set-OfficeWebAppsMachine -Roles FrontEnd ``` This example configures the current server as a Front End server. ### EXAMPLE 3 -``` + +```powershell Set-OfficeWebAppsMachine -Roles All ``` @@ -50,8 +56,8 @@ This example configures the current server to host all roles. ## PARAMETERS ### -Confirm + Prompts you for confirmation before executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter @@ -66,9 +72,10 @@ Accept wildcard characters: False ``` ### -Master -Specifies the server that stores the master farm configuration files. -If you set the local server as the master, you must run Set-OfficeWebAppsMachine -Master on all of the remaining servers in the Office Online Server farm to point them to the new master. +Specifies the server that stores the master farm configuration files. If you set the local server as +the master, you must run Set-OfficeWebAppsMachine -Master on all of the remaining servers in the +Office Online Server farm to point them to the new master. ```yaml Type: String @@ -83,19 +90,15 @@ Accept wildcard characters: False ``` ### -Roles -Specifies the list of server roles to assign to the local server, separated by commas. - -The role types are as follows: - -All -FrontEnd +Specifies the list of server roles to assign to the local server, separated by commas. The role +types are as follows: -WordBackEnd - -ExcelBackEnd - -PowerPointBackEnd +- All +- FrontEnd +- WordBackEnd +- ExcelBackEnd +- PowerPointBackEnd As a best practice, we recommend that all servers in an Office Online Server farm run all roles. Assigning roles is not useful until the Office Online Server farm contains approximately 50 servers. @@ -113,8 +116,8 @@ Accept wildcard characters: False ``` ### -WhatIf + Displays a message that describes the effect of the command instead of executing the command. -For more information, type the following command: get-help about_commonparameters ```yaml Type: SwitchParameter diff --git a/teams/teams-ps/teams/Add-TeamChannelUser.md b/teams/teams-ps/MicrosoftTeams/Add-TeamChannelUser.md similarity index 97% rename from teams/teams-ps/teams/Add-TeamChannelUser.md rename to teams/teams-ps/MicrosoftTeams/Add-TeamChannelUser.md index dcc55539d1..6d006bf2b2 100644 --- a/teams/teams-ps/teams/Add-TeamChannelUser.md +++ b/teams/teams-ps/MicrosoftTeams/Add-TeamChannelUser.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/add-teamchanneluser -title: Add-TeamChannelUser schema: 2.0.0 +title: Add-TeamChannelUser --- # Add-TeamChannelUser @@ -11,10 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds an owner or member to the private channel. -The command will return immediately, but the Teams application will not reflect the update immediately. To see the update you should refresh the members page. - -Note: Technical limitations of private channels apply. To add a user as a member to a channel, they need to first be a member of the team. To make a user an owner of a channel, they need to first be a member of the channel. - ## SYNTAX ``` @@ -23,6 +20,10 @@ Add-TeamChannelUser -GroupId -DisplayName -User [-Rol ## DESCRIPTION +The command will return immediately, but the Teams application will not reflect the update immediately. To see the update you should refresh the members page. + +Note: Technical limitations of private channels apply. To add a user as a member to a channel, they need to first be a member of the team. To make a user an owner of a channel, they need to first be a member of the channel. + Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). ## EXAMPLES @@ -50,8 +51,8 @@ Adds external user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 to a shared channel. ## PARAMETERS -### -GroupId -GroupId of the parent team +### -DisplayName +Display name of the private channel ```yaml Type: String @@ -65,8 +66,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Display name of the private channel +### -GroupId +GroupId of the parent team ```yaml Type: String @@ -80,24 +81,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -User -User's UPN (user principal name - e.g. -johndoe@example.com) +### -Role +Owner ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Role -Owner +### -TenantId +TenantId of the external user ```yaml Type: String @@ -111,15 +111,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -TenantId -TenantId of the external user +### -User +User's UPN (user principal name - e.g. +johndoe@example.com) ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) @@ -131,7 +132,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, DisplayName, User, Role, TenantId +### GroupId + +### DisplayName + +### User + +### Role + +### TenantId ## OUTPUTS diff --git a/teams/teams-ps/teams/Add-TeamUser.md b/teams/teams-ps/MicrosoftTeams/Add-TeamUser.md similarity index 98% rename from teams/teams-ps/teams/Add-TeamUser.md rename to teams/teams-ps/MicrosoftTeams/Add-TeamUser.md index 91f29ce8bb..264c87e52c 100644 --- a/teams/teams-ps/teams/Add-TeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Add-TeamUser.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/add-teamuser -title: Add-TeamUser schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Add-TeamUser --- # Add-TeamUser @@ -51,32 +51,32 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -User -UPN of a user of the organization (user principal name - e.g. johndoe@example.com). +### -Role +Member or Owner. If Owner is specified then the user is also added as a member to the Team backed by unified group. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: Member Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Role -Member or Owner. If Owner is specified then the user is also added as a member to the Team backed by unified group. +### -User +UPN of a user of the organization (user principal name - e.g. johndoe@example.com). ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: Member +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -86,7 +86,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, User, Role +### GroupId + +### User + +### Role ## OUTPUTS diff --git a/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/Clear-CsOnlineTelephoneNumberOrder.md similarity index 98% rename from teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/Clear-CsOnlineTelephoneNumberOrder.md index 36eee8cbf2..74de188a5e 100644 --- a/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/Clear-CsOnlineTelephoneNumberOrder.md @@ -1,13 +1,14 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: Clear-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder +schema: 2.0.0 +title: Clear-CsOnlineTelephoneNumberOrder --- # Clear-CsOnlineTelephoneNumberOrder @@ -28,7 +29,7 @@ Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telepho ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Clear-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 diff --git a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md b/teams/teams-ps/MicrosoftTeams/Clear-TeamsEnvironmentConfig.md similarity index 99% rename from teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md rename to teams/teams-ps/MicrosoftTeams/Clear-TeamsEnvironmentConfig.md index 62e51c733c..24a8ce47d6 100644 --- a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/MicrosoftTeams/Clear-TeamsEnvironmentConfig.md @@ -1,13 +1,14 @@ --- +author: VikneshMSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Locale: en-US +manager: vinelap Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/clear-teamsenvironmentconfig -title: Clear-TeamsEnvironmentConfig -schema: 2.0.0 -author: VikneshMSFT ms.author: vimohan ms.reviewer: pbafna -manager: vinelap +online version: https://learn.microsoft.com/powershell/module/teams/clear-teamsenvironmentconfig +schema: 2.0.0 +title: Clear-TeamsEnvironmentConfig --- # Clear-TeamsEnvironmentConfig diff --git a/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/Complete-CsOnlineTelephoneNumberOrder.md similarity index 98% rename from teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/Complete-CsOnlineTelephoneNumberOrder.md index 8e367470c6..0009e906e7 100644 --- a/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/Complete-CsOnlineTelephoneNumberOrder.md @@ -1,13 +1,14 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: Complete-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder +schema: 2.0.0 +title: Complete-CsOnlineTelephoneNumberOrder --- # Complete-CsOnlineTelephoneNumberOrder @@ -28,7 +29,7 @@ Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific te ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Complete-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 | fl diff --git a/teams/teams-ps/teams/Connect-MicrosoftTeams.md b/teams/teams-ps/MicrosoftTeams/Connect-MicrosoftTeams.md similarity index 98% rename from teams/teams-ps/teams/Connect-MicrosoftTeams.md rename to teams/teams-ps/MicrosoftTeams/Connect-MicrosoftTeams.md index c713e2275a..997aa1f359 100644 --- a/teams/teams-ps/teams/Connect-MicrosoftTeams.md +++ b/teams/teams-ps/MicrosoftTeams/Connect-MicrosoftTeams.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams -title: Connect-MicrosoftTeams schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Connect-MicrosoftTeams --- # Connect-MicrosoftTeams @@ -338,6 +338,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Login using managed service identity in the current environment. For *-Cs cmdlets, this is supported from version 5.8.1-preview onwards. + +> [!Note] +> This is currently only supported in commercial environments. A few [cmdlets](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication#cmdlets-supported) that don't support application-based authentication are not supported either. + +```yaml +Type: SwitchParameter +Parameter Sets: ManagedServiceLogin +Aliases: MSI, ManagedService +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LogFilePath The path where the log file for this PowerShell session is written to. Provide a value here if you need to deviate from the default PowerShell log file location. @@ -375,14 +392,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsAccessToken (Removed from version 2.3.2-preview) -Specifies a Microsoft Graph access token. -> [!WARNING] ->This parameter has been removed from version 2.3.2-preview. +### -ManagedServiceHostName +Host name for managed service login. ```yaml Type: String -Parameter Sets: AccessToken +Parameter Sets: ManagedServiceLogin Aliases: Required: False Position: Named @@ -391,17 +406,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantId -Specifies the ID of a tenant. - -If you do not specify this parameter, the account is authenticated with the home tenant. - -You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. +### -ManagedServicePort +Port number for managed service login. ```yaml -Type: String -Parameter Sets: UserCredential, AccessToken -Aliases: Domain, TenantDomain +Type: Int32 +Parameter Sets: ManagedServiceLogin +Aliases: Required: False Position: Named Default value: None @@ -409,28 +420,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ManagedServiceSecret +Secret, used for some kinds of managed service login. + ```yaml -Type: String -Parameter Sets: ServicePrincipalCertificate -Aliases: Domain, TenantDomain -Required: True +Type: SecureString +Parameter Sets: ManagedServiceLogin +Aliases: +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -MsAccessToken (Removed from version 2.3.2-preview) +Specifies a Microsoft Graph access token. +> [!WARNING] +>This parameter has been removed from version 2.3.2-preview. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: String +Parameter Sets: AccessToken +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -454,30 +469,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Login using managed service identity in the current environment. For *-Cs cmdlets, this is supported from version 5.8.1-preview onwards. - -> [!Note] -> This is currently only supported in commercial environments. A few [cmdlets](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication#cmdlets-supported) that don't support application-based authentication are not supported either. +### -TenantId +Specifies the ID of a tenant. -```yaml -Type: SwitchParameter -Parameter Sets: ManagedServiceLogin -Aliases: MSI, ManagedService -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +If you do not specify this parameter, the account is authenticated with the home tenant. -### -ManagedServiceHostName -Host name for managed service login. +You must specify the TenantId parameter to authenticate as a service principal or when using Microsoft account. ```yaml Type: String -Parameter Sets: ManagedServiceLogin -Aliases: +Parameter Sets: UserCredential, AccessToken, ServicePrincipalCertificate +Aliases: Domain, TenantDomain Required: False Position: Named Default value: None @@ -485,27 +487,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ManagedServicePort -Port number for managed service login. +### -UseDeviceAuthentication +Use device code authentication instead of a browser control. ```yaml -Type: Int32 -Parameter Sets: ManagedServiceLogin +Type: SwitchParameter +Parameter Sets: UserCredential Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -ManagedServiceSecret -Secret, used for some kinds of managed service login. - -```yaml -Type: SecureString -Parameter Sets: ManagedServiceLogin -Aliases: Required: False Position: Named Default value: None @@ -513,17 +502,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDeviceAuthentication -Use device code authentication instead of a browser control. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter -Parameter Sets: UserCredential -Aliases: - +Parameter Sets: (All) +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md b/teams/teams-ps/MicrosoftTeams/Disable-CsOnlineSipDomain.md similarity index 95% rename from teams/teams-ps/teams/Disable-CsOnlineSipDomain.md rename to teams/teams-ps/MicrosoftTeams/Disable-CsOnlineSipDomain.md index 932a55f2fe..6ebd36a927 100644 --- a/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md +++ b/teams/teams-ps/MicrosoftTeams/Disable-CsOnlineSipDomain.md @@ -1,20 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain applicable: Microsoft Teams -title: Disable-CsOnlineSipDomain -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain +schema: 2.0.0 +title: Disable-CsOnlineSipDomain --- # Disable-CsOnlineSipDomain ## SYNOPSIS -This cmdlet prevents provisioning of users in Skype for Business Online for the specified domain. This cmdlet allows organizations with multiple on-premises deployments of Skype For Business Server or Lync Server to safely synchronize users from multiple forests into a single Office 365 tenant. +This cmdlet prevents provisioning of users in Skype for Business Online for the specified domain. ## SYNTAX @@ -23,6 +25,8 @@ Disable-CsOnlineSipDomain -Domain [-Force] [-Confirm] [ [-Force] [-Confirm] [ Applicable: Microsoft Teams + +The AssociatedOnly parameter instructs the cmdlet to return only application instances that are associated to a configuration. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -ExactMatchOnly + +> Applicable: Microsoft Teams + The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -90,30 +95,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AssociatedOnly -The AssociatedOnly parameter instructs the cmdlet to return only application instances that are associated to a configuration. +### -Force + +> Applicable: Microsoft Teams + +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -UnAssociatedOnly -The UnAssociatedOnly parameter instructs the cmdlet to return only application instances that are not associated to any configuration. +### -MaxResults + +> Applicable: Microsoft Teams + +The MaxResults parameter identifies the maximum number of results to return. If this parameter is not provided, the default is value is 10. Max allowed value is 20. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -122,34 +131,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxResults -The MaxResults parameter identifies the maximum number of results to return. If this parameter is not provided, the default is value is 10. Max allowed value is 20. +### -SearchQuery + +> Applicable: Microsoft Teams + +The SearchQuery parameter defines a query for application instances by display name, telephone number, or GUID of the application instance. This parameter accepts partial queries for display names and telephone numbers. The search is not case sensitive. ```yaml -Type: UInt32 +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. +### -UnAssociatedOnly + +> Applicable: Microsoft Teams + +The UnAssociatedOnly parameter instructs the cmdlet to return only application instances that are not associated to any configuration. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Get-ALLM365TeamsApps.md b/teams/teams-ps/MicrosoftTeams/Get-ALLM365TeamsApps.md similarity index 99% rename from teams/teams-ps/teams/Get-ALLM365TeamsApps.md rename to teams/teams-ps/MicrosoftTeams/Get-ALLM365TeamsApps.md index b3dd4967bb..8aadc08d8a 100644 --- a/teams/teams-ps/teams/Get-ALLM365TeamsApps.md +++ b/teams/teams-ps/MicrosoftTeams/Get-ALLM365TeamsApps.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Get-ALLM365TeamsApps applicable: Microsoft Teams -title: Get-ALLM365TeamsApps author: lkueter -ms.author: sribagchi +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 04/24/2024 +online version: https://docs.microsoft.com/powershell/module/teams/Get-ALLM365TeamsApps schema: 2.0.0 +title: Get-ALLM365TeamsApps --- # Get-AllM365TeamsApps diff --git a/teams/teams-ps/teams/Get-AssociatedTeam.md b/teams/teams-ps/MicrosoftTeams/Get-AssociatedTeam.md similarity index 99% rename from teams/teams-ps/teams/Get-AssociatedTeam.md rename to teams/teams-ps/MicrosoftTeams/Get-AssociatedTeam.md index 2bc7566964..4f1198e33f 100644 --- a/teams/teams-ps/teams/Get-AssociatedTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Get-AssociatedTeam.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-associatedteam -title: Get-AssociatedTeam -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/teams/get-associatedteam +schema: 2.0.0 +title: Get-AssociatedTeam --- # Get-AssociatedTeam diff --git a/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationAccessPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsApplicationAccessPolicy.md index a3cd76b4a4..f6eeff446b 100644 --- a/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csapplicationaccesspolicy applicable: Microsoft Teams -title: Get-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni author: frankpeng7 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csapplicationaccesspolicy +schema: 2.0.0 +title: Get-CsApplicationAccessPolicy --- # Get-CsApplicationAccessPolicy @@ -55,33 +56,33 @@ In the command shown above, information is returned for a single application acc ## PARAMETERS -### -Identity +### -Filter -Unique identifier assigned to the policy when it was created. +A filter that is not expressed in the standard wildcard language. ```yaml -Type: XdsIdentity -Parameter Sets: (All) +Type: String +Parameter Sets: Filter Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter +### -Identity -A filter that is not expressed in the standard wildcard language. +Unique identifier assigned to the policy when it was created. ```yaml -Type: String -Parameter Sets: Filter +Type: XdsIdentity +Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationMeetingConfiguration.md similarity index 97% rename from teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsApplicationMeetingConfiguration.md index 0980ee7a04..5d2312710a 100644 --- a/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsApplicationMeetingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-CsApplicationMeetingConfiguration applicable: Teams -title: Get-CsApplicationMeetingConfiguration -schema: 2.0.0 -manager: zhengni author: jackry6350 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: yoren -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-CsApplicationMeetingConfiguration +schema: 2.0.0 +title: Get-CsApplicationMeetingConfiguration --- # Get-CsApplicationMeetingConfiguration @@ -40,50 +41,54 @@ The command shown above returns application meeting configuration settings that ## PARAMETERS -### -Identity +### -Filter -Unique identifier of the application meeting configuration settings to be returned. -Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsApplicationMeetingConfiguration cmdlet. -However, you can use the following syntax to retrieve the global settings: -Identity global. +> Applicable: Teams + +Enables you to use wildcards when specifying the application meeting configuration settings to be returned. +Because you can only have a single, global instance of these settings there is little reason to use the Filter parameter. +However, if you prefer, you can use syntax similar to this to retrieve the global settings: -Identity "g*". ```yaml -Type: XdsIdentity -Parameter Sets: (All) +Type: String +Parameter Sets: Filter Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the application meeting configuration settings to be returned. -Because you can only have a single, global instance of these settings there is little reason to use the Filter parameter. -However, if you prefer, you can use syntax similar to this to retrieve the global settings: -Identity "g*". +### -Identity + +Unique identifier of the application meeting configuration settings to be returned. +Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsApplicationMeetingConfiguration cmdlet. +However, you can use the following syntax to retrieve the global settings: -Identity global. ```yaml -Type: String -Parameter Sets: Filter +Type: XdsIdentity +Parameter Sets: (All) Aliases: -Applicable: Teams -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Teams + Retrieves the application meeting configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendant.md similarity index 99% rename from teams/teams-ps/teams/Get-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendant.md index 7fc22623fe..caf757e1a4 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendant applicable: Microsoft Teams -title: Get-CsAutoAttendant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendant +schema: 2.0.0 +title: Get-CsAutoAttendant --- # Get-CsAutoAttendant @@ -73,30 +75,27 @@ This example skips initial 5 auto attendants and gets the next 10 AAs configured ## PARAMETERS -### -Identity -The identity for the AA to be retrieved. If this parameter is not specified, then all created AAs in the organization are returned. -If you specify this parameter, you can't specify the other parameters. +### -Descending +If specified, the retrieved auto attendants would be sorted in descending order. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -First -The First parameter gets the first N auto attendants, up to a maximum of 100 at a time. -When not specified, the default behavior is to return the first 100 auto attendants. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. -If a number greater than 100 is supplied, the request will fail. +### -ExcludeContent +If specified, only auto attendants' names, identities and associated application instances will be retrieved. ```yaml -Type: System.UInt32 +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -108,8 +107,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Skip -The Skip parameter skips the first N auto attendants. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. +### -First +The First parameter gets the first N auto attendants, up to a maximum of 100 at a time. +When not specified, the default behavior is to return the first 100 auto attendants. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. +If a number greater than 100 is supplied, the request will fail. ```yaml Type: System.UInt32 @@ -124,8 +125,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NameFilter -If specified, only auto attendants whose names match that value would be returned. +### -Identity +The identity for the AA to be retrieved. If this parameter is not specified, then all created AAs in the organization are returned. +If you specify this parameter, you can't specify the other parameters. ```yaml Type: System.String @@ -134,17 +136,17 @@ Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -SortBy -If specified, the retrieved auto attendants would be sorted by the specified property. +### -IncludeStatus +If specified, the status records for each auto attendant in the result set are also retrieved. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -156,11 +158,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Descending -If specified, the retrieved auto attendants would be sorted in descending order. +### -NameFilter +If specified, only auto attendants whose names match that value would be returned. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -172,11 +174,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeStatus -If specified, the status records for each auto attendant in the result set are also retrieved. +### -Skip +The Skip parameter skips the first N auto attendants. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. ```yaml -Type: SwitchParameter +Type: System.UInt32 Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -188,11 +190,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeContent -If specified, only auto attendants' names, identities and associated application instances will be retrieved. +### -SortBy +If specified, the retrieved auto attendants would be sorted by the specified property. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantHolidays.md similarity index 94% rename from teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantHolidays.md index 92114b548b..02b3852b03 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantHolidays.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays applicable: Microsoft Teams -title: Get-CsAutoAttendantHolidays -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays +schema: 2.0.0 +title: Get-CsAutoAttendantHolidays --- # Get-CsAutoAttendantHolidays @@ -26,28 +28,28 @@ The Get-CsAutoAttendantHolidays provides a convenient way to visualize the infor ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` In this example, the Get-CsAutoAttendantHolidays cmdlet is used to get all holidays in an auto attendant with Identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -Years @(2017) ``` In this example, the Get-CsAutoAttendantHolidays cmdlet is used to get all holidays in year 2017 in an auto attendant with Identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -Years @(2017) -Names @("Christmas") ``` In this example, the Get-CsAutoAttendantHolidays cmdlet is used to get holiday named Christmas in the year 2017 in an auto attendant with Identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` (Get-CsAutoAttendantHolidays -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -Years @(2017) -Names @("Christmas")).DateTimeRanges ``` @@ -56,42 +58,42 @@ In this example, the Get-CsAutoAttendantHolidays cmdlet is used to retrieve the ## PARAMETERS -### -Identity -Represents the identifier for the auto attendant whose holidays are to be retrieved. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams - -Required: True -Position: 0 +Required: False +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Identity +Represents the identifier for the auto attendant whose holidays are to be retrieved. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False -Position: Named + +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Years -The Years parameter represents the years for the holidays to be retrieved. If this parameter is not specified, then holidays for all years in the AA are returned. +### -Names +The Names parameter represents the names for the holidays to be retrieved. If this parameter is not specified, then all holidays in the AA are returned. ```yaml -Type: System.Collections.Generic.List[System.String] +Type: System.Collections.Generic.List[System.Int32] Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -103,11 +105,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Names -The Names parameter represents the names for the holidays to be retrieved. If this parameter is not specified, then all holidays in the AA are returned. +### -Years +The Years parameter represents the years for the holidays to be retrieved. If this parameter is not specified, then holidays for all years in the AA are returned. ```yaml -Type: System.Collections.Generic.List[System.Int32] +Type: System.Collections.Generic.List[System.String] Parameter Sets: (All) Aliases: applicable: Microsoft Teams diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantStatus.md similarity index 95% rename from teams/teams-ps/teams/Get-CsAutoAttendantStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantStatus.md index 69b5630115..fb66b49e79 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus applicable: Microsoft Teams -title: Get-CsAutoAttendantStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus +schema: 2.0.0 +title: Get-CsAutoAttendantStatus --- # Get-CsAutoAttendantStatus @@ -26,14 +28,14 @@ This cmdlet provides a way to return the provisioning status of an auto attendan ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` In Example 1, the Get-CsAutoAttendantStatus cmdlet is used to get status records for all resources of an auto attendant with identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" -IncludeResources @("AudioFile") ``` diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage.md similarity index 94% rename from teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage.md index c6cb4253af..bc8b5d5507 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedLanguage.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage applicable: Microsoft Teams -title: Get-CsAutoAttendantSupportedLanguage -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage +schema: 2.0.0 +title: Get-CsAutoAttendantSupportedLanguage --- # Get-CsAutoAttendantSupportedLanguage @@ -26,14 +28,14 @@ The Get-CsAutoAttendantSupportedLanguage cmdlet gets all languages (and their co ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantSupportedLanguage ``` This example gets all supported languages. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantSupportedLanguage -Identity "en-US" ``` diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone.md similarity index 94% rename from teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone.md index 1e0491d7e4..018f8a8eda 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantSupportedTimeZone.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone applicable: Microsoft Teams -title: Get-CsAutoAttendantSupportedTimeZone -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone +schema: 2.0.0 +title: Get-CsAutoAttendantSupportedTimeZone --- # Get-CsAutoAttendantSupportedTimeZone @@ -26,14 +28,14 @@ The Get-CsAutoAttendantSupportedTimeZone cmdlet gets all the time zones that the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantSupportedTimeZone ``` This example gets all supported time zones. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoAttendantSupportedTimeZone -Identity "Pacific Standard Time" ``` diff --git a/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantTenantInformation.md similarity index 95% rename from teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantTenantInformation.md index 92a3a9bbc1..c9d5c3e3ad 100644 --- a/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsAutoAttendantTenantInformation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendanttenantinformation applicable: Microsoft Teams -title: Get-CsAutoAttendantTenantInformation -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendanttenantinformation +schema: 2.0.0 +title: Get-CsAutoAttendantTenantInformation --- # Get-CsAutoAttendantTenantInformation @@ -26,7 +28,7 @@ The Get-CsAutoAttendantTenantInformation cmdlet gets the default tenant informat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoAttendantTenantInformation ``` diff --git a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/MicrosoftTeams/Get-CsBatchPolicyAssignmentOperation.md similarity index 99% rename from teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsBatchPolicyAssignmentOperation.md index b9a3895727..da6daf0018 100644 --- a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsBatchPolicyAssignmentOperation.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation -title: Get-CsBatchPolicyAssignmentOperation -schema: 2.0.0 -author: tomkau ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation +schema: 2.0.0 +title: Get-CsBatchPolicyAssignmentOperation --- # Get-CsBatchPolicyAssignmentOperation @@ -90,36 +91,6 @@ In this example, the UserState property is expanded to see the status of each us ## PARAMETERS -### -Identity -The ID of a batch policy assignment operation. - -```yaml -Type: String -Parameter Sets: Get1 -Aliases: OperationId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Option filter - -```yaml -Type: String -Parameter Sets: Get -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Break Wait for .NET debugger to attach @@ -165,6 +136,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +The ID of a batch policy assignment operation. + +```yaml +Type: String +Parameter Sets: Get1 +Aliases: OperationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Proxy The URI for the proxy server to use @@ -210,6 +196,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Status +Option filter + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsBatchTeamsDeploymentStatus.md similarity index 96% rename from teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsBatchTeamsDeploymentStatus.md index 2fdd9166f2..1b15d4aa4f 100644 --- a/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsBatchTeamsDeploymentStatus.md @@ -1,85 +1,86 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsBatchTeamsDeploymentStatus -title: Get-CsBatchTeamsDeploymentStatus -schema: 2.0.0 ---- - -# Get-CsBatchTeamsDeploymentStatus - -## SYNOPSIS - -This cmdlet is used to get the status of the batch deployment orchestration. - -## SYNTAX - -```powershell -Get-CsBatchTeamsDeploymentStatus -OrchestrationId - -InputObject - [] -``` - -## DESCRIPTION -After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus. - -To learn more, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id" -``` - -This command provides the status of the specified batch deployment orchestrationId. - -## PARAMETERS - -### OrchestrationId -This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The Identity parameter. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Status of the orchestrationId - -Running: The orchestration is running. -Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. - -## NOTES - -## RELATED LINKS - -[New-CsBatchTeamsDeployment](https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsBatchTeamsDeploymentStatus +schema: 2.0.0 +title: Get-CsBatchTeamsDeploymentStatus +--- + +# Get-CsBatchTeamsDeploymentStatus + +## SYNOPSIS + +This cmdlet is used to get the status of the batch deployment orchestration. + +## SYNTAX + +```powershell +Get-CsBatchTeamsDeploymentStatus -OrchestrationId + -InputObject + [] +``` + +## DESCRIPTION +After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus. + +To learn more, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id" +``` + +This command provides the status of the specified batch deployment orchestrationId. + +## PARAMETERS + +### OrchestrationId +This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Status of the orchestrationId + +Running: The orchestration is running. +Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. + +## NOTES + +## RELATED LINKS + +[New-CsBatchTeamsDeployment](https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment) diff --git a/teams/teams-ps/teams/Get-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/Get-CsCallQueue.md similarity index 96% rename from teams/teams-ps/teams/Get-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/Get-CsCallQueue.md index 9ea06bec8e..fd84ad1761 100644 --- a/teams/teams-ps/teams/Get-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsCallQueue.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cscallqueue applicable: Microsoft Teams -title: Get-CsCallQueue -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-cscallqueue +schema: 2.0.0 +title: Get-CsCallQueue --- # Get-CsCallQueue @@ -27,14 +28,14 @@ The Get-CsCallQueue cmdlet lets you retrieve information about the Call Queues i ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCallQueue ``` This example gets the first 100 call queues in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCallQueue -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` @@ -43,11 +44,11 @@ This example gets the Call Queue with the identity 5e3a575e-1faa-49ff-83c2-5cf1c ## PARAMETERS -### -Identity -PARAMVALUE: Guid +### -Descending +The Descending parameter sorts Call Queues in descending order ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -59,11 +60,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -ExcludeContent +The ExcludeContent parameter only displays the Name and Id of the Call Queues ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -76,7 +77,7 @@ Accept wildcard characters: False ``` ### -First -The First parameter gets the first N Call Queues, up to a maximum of 100 at a time. +The First parameter gets the first N Call Queues, up to a maximum of 100 at a time. When not specified, the default behavior is to return the first 100 call queues. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. If a number greater than 100 is supplied, the request will fail. @@ -93,11 +94,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Skip -The Skip parameter skips the first N call queues. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. +### -Identity +PARAMVALUE: Guid ```yaml -Type: Int32 +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -109,64 +110,64 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeContent -The ExcludeContent parameter only displays the Name and Id of the Call Queues +### -NameFilter +The NameFilter parameter returns Call Queues where name contains specified string ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Sort -The Sort parameter specifies the property used to sort. +### -Skip +The Skip parameter skips the first N call queues. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. ```yaml -Type: String +Type: Int32 Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: Name +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Descending -The Descending parameter sorts Call Queues in descending order +### -Sort +The Sort parameter specifies the property used to sort. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: None +Default value: Name Accept pipeline input: False Accept wildcard characters: False ``` -### -NameFilter -The NameFilter parameter returns Call Queues where name contains specified string +### -Tenant +PARAMVALUE: Guid ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Get-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Get-CsCallingLineIdentity.md similarity index 98% rename from teams/teams-ps/teams/Get-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Get-CsCallingLineIdentity.md index bbd56f2336..c6045c17fd 100644 --- a/teams/teams-ps/teams/Get-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity applicable: Microsoft Teams -title: Get-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity +schema: 2.0.0 +title: Get-CsCallingLineIdentity --- # Get-CsCallingLineIdentity @@ -48,33 +49,33 @@ The example gets and displays the Caller ID policies with Identity starting with ## PARAMETERS -### -Identity -The Identity parameter identifies the Caller ID policy. +### -Filter +The Filter parameter lets you insert a string through which your search results are filtered. ```yaml Type: String -Parameter Sets: (Identity) +Parameter Sets: (Filter) Aliases: applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter lets you insert a string through which your search results are filtered. +### -Identity +The Identity parameter identifies the Caller ID policy. ```yaml Type: String -Parameter Sets: (Filter) +Parameter Sets: (Identity) Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md b/teams/teams-ps/MicrosoftTeams/Get-CsCloudCallDataConnection.md similarity index 99% rename from teams/teams-ps/teams/Get-CsCloudCallDataConnection.md rename to teams/teams-ps/MicrosoftTeams/Get-CsCloudCallDataConnection.md index f2b7e131f9..54abd8a7a9 100644 --- a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsCloudCallDataConnection.md @@ -1,15 +1,15 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Get-CsCloudCallDataConnection -online version: https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection -schema: 2.0.0 author: 2012ucp1544 +external help file: MicrosoftTeams-help.xml +Locale: en-US +manager: subadjat +Module Name: MicrosoftTeams ms.author: uditagrawal ms.reviewer: pbafna -manager: subadjat - +online version: https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection +schema: 2.0.0 +title: Get-CsCloudCallDataConnection --- # Get-CsCloudCallDataConnection diff --git a/teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/Get-CsComplianceRecordingForCallQueueTemplate.md similarity index 94% rename from teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md rename to teams/teams-ps/MicrosoftTeams/Get-CsComplianceRecordingForCallQueueTemplate.md index 9d668b7749..0fd5b26a1c 100644 --- a/teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsComplianceRecordingForCallQueueTemplate.md @@ -1,17 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsComplianceRecordingForCallQueueTemplate applicable: Microsoft Teams -title: Get-CsComplianceRecordingForCallQueueTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: Get-CsComplianceRecordingForCallQueueTemplate --- # Get-CsComplianceRecordingForCallQueueTemplate +## SYNOPSIS +Retrieves a Compliance Recording for Call Queues template. + ## SYNTAX ```powershell @@ -26,14 +30,14 @@ Use the Get-CsComplianceRecordingForCallQueueTemplate cmdlet to retrieve a Compl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsComplianceRecordingForCallQueueTemplate ``` This example gets all Compliance Recording for Call Queue Templates in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` diff --git a/teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Get-CsEffectiveTenantDialPlan.md similarity index 97% rename from teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Get-CsEffectiveTenantDialPlan.md index e7be699f75..c884699b58 100644 --- a/teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsEffectiveTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cseffectivetenantdialplan applicable: Microsoft Teams -title: Get-CsEffectiveTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-cseffectivetenantdialplan +schema: 2.0.0 +title: Get-CsEffectiveTenantDialPlan --- # Get-CsEffectiveTenantDialPlan @@ -28,7 +29,7 @@ the EnterpriseVoice features. The EffectiveTenantDialPlanName is in the form Ten ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsEffectiveTenantDialPlan -Identity Vt1_User1 ``` @@ -37,33 +38,33 @@ This example gets the effective tenant dial plan for the Vt1_User1. ## PARAMETERS -### -Identity -The Identity parameter is the unique identifier of the user for whom to retrieve the effective tenant dial plan. +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: UserIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Identity +The Identity parameter is the unique identifier of the user for whom to retrieve the effective tenant dial plan. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsExportAcquiredPhoneNumberStatus.md similarity index 98% rename from teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsExportAcquiredPhoneNumberStatus.md index 1571bfb68b..1ee4b543d0 100644 --- a/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsExportAcquiredPhoneNumberStatus.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus applicable: Microsoft Teams -title: Get-CsExportAcquiredPhoneNumberStatus author: pavellatif -ms.author: pavellatif -ms.reviewer: +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +online version: https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus schema: 2.0.0 +title: Get-CsExportAcquiredPhoneNumberStatus --- # Get-CsExportAcquiredPhoneNumberStatus diff --git a/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsExternalAccessPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsExternalAccessPolicy.md index 6b5e5dfbaa..32d34c03f8 100644 --- a/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsExternalAccessPolicy.md @@ -1,21 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy applicable: Microsoft Teams -title: Get-CsExternalAccessPolicy -schema: 2.0.0 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy +schema: 2.0.0 +title: Get-CsExternalAccessPolicy --- # Get-CsExternalAccessPolicy ## SYNOPSIS Returns information about the external access policies that have been configured for use in your organization. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. - -This cmdlet was introduced in Lync Server 2010. ## SYNTAX @@ -32,6 +31,10 @@ Get-CsExternalAccessPolicy [-Tenant ] [-Include ] [-Applicab ``` ## DESCRIPTION +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. + +This cmdlet was introduced in Lync Server 2010. + When you first configure Skype for Business Online your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Online organization or in your Active Directory Domain Services for on-premises deployments. For on-premises deployments, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. @@ -55,7 +58,7 @@ The Get-CsExternalAccessPolicy cmdlet provides a way for you to return informati ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-CsExternalAccessPolicy ``` @@ -63,7 +66,7 @@ Get-CsExternalAccessPolicy Example 1 returns a collection of all the external access policies configured for use in your organization. Calling the Get-CsExternalAccessPolicy cmdlet without any additional parameters always returns the complete collection of external access policies. -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Online) +### EXAMPLE 2 (Skype for Business Online) ``` Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" ``` @@ -71,7 +74,7 @@ Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" Example 2 uses the Identity parameter to return the external access policy that has the Identity tag:RedmondExternalAccessPolicy. Because access policy Identities must be unique, this command will never return more than one item. -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 2 (Skype for Business Server 2015) ``` Get-CsExternalAccessPolicy -Identity site:Redmond ``` @@ -79,7 +82,7 @@ Get-CsExternalAccessPolicy -Identity site:Redmond Example 2 uses the Identity parameter to return the external access policy that has the Identity site:Redmond. Because access policy Identities must be unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsExternalAccessPolicy -Filter tag:* ``` @@ -87,7 +90,7 @@ Get-CsExternalAccessPolicy -Filter tag:* The command shown in Example 3 uses the Filter parameter to return all of the external access policies that have been configured at the per-user scope; the parameter value "tag:*" limits returned data to those policies that have an Identity that begins with the string value "tag:". By definition, any policy that has an Identity beginning with "tag:" is a policy that has been configured at the per-user scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} ``` @@ -96,7 +99,7 @@ In Example 4, the Get-CsExternalAccessPolicy cmdlet and the Where-Object cmdlet To do this, the Get-CsExternalAccessPolicy cmdlet is first used to return a collection of all the external access policies currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the EnableFederationAccess property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True} ``` @@ -106,7 +109,7 @@ In order to perform this task, the command first uses the Get-CsExternalAccessPo That collection is then piped to the Where-Object cmdlet, which picks out only those policies that meet two criteria: the EnableFederationAccess property must be equal to True and the EnablePublicCloudAccess property must also be equal to True. Only policies in which both EnableFederationAccess and EnablePublicCloudAccess are True will be returned and displayed on the screen. -### -------------------------- EXAMPLE 6 -------------------------- +### EXAMPLE 6 ``` Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com" ``` @@ -119,25 +122,28 @@ NOTE: This command requires the Office 365 UsageLocation property to be configur ## PARAMETERS -### -Identity -Unique Identity assigned to the policy when it was created. -External access policies can be assigned at the global, site, or per-user scope. -To refer to the global instance use this syntax: -Identity global. -To refer to a policy at the site scope, use this syntax: -Identity site:Redmond. -To refer to a policy at the per-user scope, use syntax similar to this: -Identity RedmondPolicy. +### -ApplicableTo +Returns a list of the external access policies that can be assigned to the specified user. +For example, to return a collection of policies that can be assigned to the user kenmyer@litwareinc.com, use this command: -Note that wildcard characters such as the asterisk (*) cannot be used with the Identity parameter. -To do a wildcard search for policies, use the Filter parameter instead. +`Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com"` -If neither the Identity nor Filter parameters are specified, then the Get-CsExternalAccessPolicy cmdlet will bring back a collection of all the external access policies configured for use in the organization. +The ApplicableTo parameter is useful because it's possible that only some of the available per-user external access policies can be assigned to a given user. +This is due to the fact that different licensing agreements and different country/region restrictions might limit the policies that can be assigned to a user. +For example, if Ken Myer works in China, country/region restrictions might limit his access to policies A, B, D, and E, Meanwhile, similar restrictions might limit Pilar Ackerman, who works in the United States, to policies A, B, C, and F. +If you call Get-CsExternalAccessPolicy without using the ApplicableTo parameter you will get back a collection of all the available policies, including any policies that can't actually be assigned to a specific user. + +The ApplicableTo parameter applies only to Skype for Business Online. +This parameter is not intended for use with the on-premises version of Skype for Business Server 2015. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) +Type: UserIdParameter +Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -182,39 +188,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the external access policy data from the local replica of the Central Management store rather than from the Central Management store itself. +### -Identity +Unique Identity assigned to the policy when it was created. +External access policies can be assigned at the global, site, or per-user scope. +To refer to the global instance use this syntax: -Identity global. +To refer to a policy at the site scope, use this syntax: -Identity site:Redmond. +To refer to a policy at the per-user scope, use syntax similar to this: -Identity RedmondPolicy. -NOTE: This parameter is not used with Skype for Business Online. +Note that wildcard characters such as the asterisk (*) cannot be used with the Identity parameter. +To do a wildcard search for policies, use the Filter parameter instead. + +If neither the Identity nor Filter parameters are specified, then the Get-CsExternalAccessPolicy cmdlet will bring back a collection of all the external access policies configured for use in the organization. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity, (All) Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicableTo -Returns a list of the external access policies that can be assigned to the specified user. -For example, to return a collection of policies that can be assigned to the user kenmyer@litwareinc.com, use this command: - -`Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com"` - -The ApplicableTo parameter is useful because it's possible that only some of the available per-user external access policies can be assigned to a given user. -This is due to the fact that different licensing agreements and different country/region restrictions might limit the policies that can be assigned to a user. -For example, if Ken Myer works in China, country/region restrictions might limit his access to policies A, B, D, and E, Meanwhile, similar restrictions might limit Pilar Ackerman, who works in the United States, to policies A, B, C, and F. -If you call Get-CsExternalAccessPolicy without using the ApplicableTo parameter you will get back a collection of all the available policies, including any policies that can't actually be assigned to a specific user. - -The ApplicableTo parameter applies only to Skype for Business Online. -This parameter is not intended for use with the on-premises version of Skype for Business Server 2015. +### -Include +PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly ```yaml -Type: UserIdParameter +Type: PolicyFilter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -226,14 +228,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Include -PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly +### -LocalStore +Retrieves the external access policy data from the local replica of the Central Management store rather than from the Central Management store itself. + +NOTE: This parameter is not used with Skype for Business Online. ```yaml -Type: PolicyFilter +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/Get-CsGroupPolicyAssignment.md similarity index 99% rename from teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsGroupPolicyAssignment.md index 015cc6cfd9..2a5d86e8f5 100644 --- a/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsGroupPolicyAssignment.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment -title: Get-CsGroupPolicyAssignment schema: 2.0.0 +title: Get-CsGroupPolicyAssignment --- # Get-CsGroupPolicyAssignment diff --git a/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Get-CsHybridTelephoneNumber.md similarity index 93% rename from teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md rename to teams/teams-ps/MicrosoftTeams/Get-CsHybridTelephoneNumber.md index 15b1d9e69b..4a1418f3cd 100644 --- a/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsHybridTelephoneNumber.md @@ -1,111 +1,112 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber -applicable: Microsoft Teams -title: Get-CsHybridTelephoneNumber -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: - ---- - -# Get-CsHybridTelephoneNumber - -## SYNOPSIS -This cmdlet displays information about one or more hybrid telephone numbers. - -> [!IMPORTANT] -> This cmdlet is being deprecated. Use the **Get-CsPhoneNumberAssignment** cmdlet to display information about one or more phone numbers. Detailed instructions on how to use the new cmdlet can be found at [Get-CsPhoneNumberAssignment](/powershell/module/teams/get-csphonenumberassignment?view=teams-ps) - -## SYNTAX - -### Assignment (Default) -```powershell -Get-CsHybridTelephoneNumber [-TelephoneNumber ] -InputObject [] -``` - -## DESCRIPTION -This cmdlet displays information about one or more hybrid telephone numbers used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - -Returned results are sorted by telephone number in ascending order. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsHybridTelephoneNumber -TelephoneNumber 14025551234 -``` -```output -Id O365Region SourceType TargetType TelephoneNumber UserId --- ---------- ---------- ---------- --------------- ------ -14025551234 NOAM Hybrid 14025551234 00000000-0000-0000-0000-000000000000 -``` -This example displays information about the phone number +1 (402) 555-1234. - -### Example 2 -```powershell -Get-CsHybridTelephoneNumber -``` -```output -Id O365Region SourceType TargetType TelephoneNumber UserId --- ---------- ---------- ---------- --------------- ------ -14025551234 Hybrid 14025551234 -14025551235 Hybrid 14025551235 -``` -This example displays information about all hybrid telephone numbers in the tenant. Note that O365Region, TargetType, and UserId will not be populated. - -## PARAMETERS - -### -TelephoneNumber -Filters the returned results to a specific phone number. The number should be specified without a prefixed "+". The phone number can't have "tel:" prefixed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The identity parameter. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -The cmdlet is available in Teams PowerShell module 4.5.0 or later. - -The cmdlet is only available in GCC High and DoD cloud instances. - -## RELATED LINKS -[New-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber) - -[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber +schema: 2.0.0 +title: Get-CsHybridTelephoneNumber +--- + +# Get-CsHybridTelephoneNumber + +## SYNOPSIS +This cmdlet displays information about one or more hybrid telephone numbers. + +## SYNTAX + +### Assignment (Default) +```powershell +Get-CsHybridTelephoneNumber [-TelephoneNumber ] -InputObject [] +``` + +## DESCRIPTION + +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the **Get-CsPhoneNumberAssignment** cmdlet to display information about one or more phone numbers. Detailed instructions on how to use the new cmdlet can be found at [Get-CsPhoneNumberAssignment](/powershell/module/teams/get-csphonenumberassignment) + +This cmdlet displays information about one or more hybrid telephone numbers used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + +Returned results are sorted by telephone number in ascending order. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsHybridTelephoneNumber -TelephoneNumber 14025551234 +``` +```output +Id O365Region SourceType TargetType TelephoneNumber UserId +-- ---------- ---------- ---------- --------------- ------ +14025551234 NOAM Hybrid 14025551234 00000000-0000-0000-0000-000000000000 +``` +This example displays information about the phone number +1 (402) 555-1234. + +### Example 2 +```powershell +Get-CsHybridTelephoneNumber +``` +```output +Id O365Region SourceType TargetType TelephoneNumber UserId +-- ---------- ---------- ---------- --------------- ------ +14025551234 Hybrid 14025551234 +14025551235 Hybrid 14025551235 +``` +This example displays information about all hybrid telephone numbers in the tenant. Note that O365Region, TargetType, and UserId will not be populated. + +## PARAMETERS + +### -InputObject +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +Filters the returned results to a specific phone number. The number should be specified without a prefixed "+". The phone number can't have "tel:" prefixed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES +The cmdlet is available in Teams PowerShell module 4.5.0 or later. + +The cmdlet is only available in GCC High and DoD cloud instances. + +## RELATED LINKS +[New-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber) + +[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Get-CsInboundBlockedNumberPattern.md similarity index 98% rename from teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Get-CsInboundBlockedNumberPattern.md index bf831c5aa7..a833fcf11e 100644 --- a/teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern applicable: Microsoft Teams -title: Get-CsInboundBlockedNumberPattern author: serdarsoysal -ms.author: serdars -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern schema: 2.0.0 +title: Get-CsInboundBlockedNumberPattern --- # Get-CsInboundBlockedNumberPattern diff --git a/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Get-CsInboundExemptNumberPattern.md similarity index 98% rename from teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Get-CsInboundExemptNumberPattern.md index 9f59ffa49a..7950ee2d2e 100644 --- a/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern applicable: Microsoft Teams -title: Get-CsInboundExemptNumberPattern -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern +schema: 2.0.0 +title: Get-CsInboundExemptNumberPattern --- # Get-CsInboundExemptNumberPattern diff --git a/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsMeetingMigrationStatus.md similarity index 97% rename from teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsMeetingMigrationStatus.md index 36129dc3a8..019fe3c13c 100644 --- a/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsMeetingMigrationStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csmeetingmigrationstatus applicable: Microsoft Teams -title: Get-CsMeetingMigrationStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csmeetingmigrationstatus +schema: 2.0.0 +title: Get-CsMeetingMigrationStatus --- # Get-CsMeetingMigrationStatus @@ -27,14 +29,14 @@ You can use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of mee ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMeetingMigrationStatus -SummaryOnly ``` This example is used to get a summary status of all MMS migrations. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingMigrationStatus -Identity "ashaw@contoso.com" ``` @@ -43,40 +45,40 @@ This example gets the meeting migration status for user ashaw@contoso.com. ## PARAMETERS -### -Identity -Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. +### -EndTime +Specifies the end date of the date range. ```yaml -Type: UserIdParameter +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StartTime -Specifies the start date of the date range. +### -Identity +Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. ```yaml -Type: Object +Type: UserIdParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EndTime -Specifies the end date of the date range. +### -StartTime +Specifies the start date of the date range. ```yaml Type: Object @@ -91,11 +93,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SummaryOnly -Specified that you want a summary status of MMS migrations returned. +### -State +With this parameter you can filter by migration state. Possible values are: + +- Pending +- InProgress +- Failed +- Succeeded ```yaml -Type: SwitchParameter +Type: StateType Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -107,16 +114,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -State -With this parameter you can filter by migration state. Possible values are: - -- Pending -- InProgress -- Failed -- Succeeded +### -SummaryOnly +Specified that you want a summary status of MMS migrations returned. ```yaml -Type: StateType +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstance.md similarity index 90% rename from teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstance.md index c153103192..04f5823ef0 100644 --- a/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance applicable: Microsoft Teams -title: Get-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance +schema: 2.0.0 +title: Get-CsOnlineApplicationInstance --- # Get-CsOnlineApplicationInstance @@ -26,27 +27,27 @@ This cmdlet is used to get details of an application instance. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineApplicationInstance -Identity appinstance01@contoso.com ``` This example returns the application instance with identity "appinstance01@contoso.com". -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsOnlineApplicationInstance -Identities appinstance01@contoso.com,appinstance02@contoso.com ``` This example returns the application instance with identities "appinstance01@contoso.com" and "appinstance02@contoso.com". Query with multiple comma separated Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell Get-CsOnlineApplicationInstance -ResultSize 10 ``` This example returns the first 10 application instances. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell Get-CsOnlineApplicationInstance ``` @@ -55,46 +56,52 @@ This example returns the details of all application instances. ## PARAMETERS -### -Identity -The UPN or the object ID of the application instance to retrieve. If this parameter nor parameter Identities are not provided, it will retrieve all application instances in the tenant. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Identities -The UPNs or the object IDs of the application instances to retrieve, separated with comma. If this parameter nor parameter Identity are not provided, it will retrieve all application instances in the tenant. +### -Force + +> Applicable: Microsoft Teams + +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ResultSize -The result size for bulk get. This parameter is currently not working. +### -Identities + +> Applicable: Microsoft Teams + +The UPNs or the object IDs of the application instances to retrieve, separated with comma. If this parameter nor parameter Identity are not provided, it will retrieve all application instances in the tenant. ```yaml -Type: System.Int32 +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,14 +110,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Skip -Skips the first specified number of returned results. The default value is 0. This parameter is currently not working. +### -Identity + +> Applicable: Microsoft Teams + +The UPN or the object ID of the application instance to retrieve. If this parameter nor parameter Identities are not provided, it will retrieve all application instances in the tenant. ```yaml -Type: System.Int32 +Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,47 +128,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. +### -ResultSize + +> Applicable: Microsoft Teams + +The result size for bulk get. This parameter is currently not working. ```yaml -Type: SwitchParameter +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Skip + +> Applicable: Microsoft Teams + +Skips the first specified number of returned results. The default value is 0. This parameter is currently not working. ```yaml -Type: SwitchParameter +Type: System.Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation.md similarity index 97% rename from teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation.md index f837f328ee..6fc1ecad25 100644 --- a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation applicable: Microsoft Teams -title: Get-CsOnlineApplicationInstanceAssociation -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation +schema: 2.0.0 +title: Get-CsOnlineApplicationInstanceAssociation --- # Get-CsOnlineApplicationInstanceAssociation @@ -26,7 +28,7 @@ Use the Get-CsOnlineApplicationInstanceAssociation cmdlet to get information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineApplicationInstanceAssociation -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus.md similarity index 97% rename from teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus.md index bf4db93e15..357903cb70 100644 --- a/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineApplicationInstanceAssociationStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus applicable: Microsoft Teams -title: Get-CsOnlineApplicationInstanceAssociationStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus +schema: 2.0.0 +title: Get-CsOnlineApplicationInstanceAssociationStatus --- # Get-CsOnlineApplicationInstanceAssociationStatus @@ -26,7 +28,7 @@ Use the Get-CsOnlineApplicationInstanceAssociationStatus cmdlet to get provision ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineApplicationInstanceAssociationStatus -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioConferencingRoutingPolicy.md similarity index 96% rename from teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioConferencingRoutingPolicy.md index e2a5e510e0..7b59d6d4e7 100644 --- a/teams/teams-ps/teams/Get-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,120 +1,121 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudioconferencingroutingpolicy -title: Get-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# Get-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet retrieves all online audio conferencing routing policies for the tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsOnlineAudioConferencingRoutingPolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## DESCRIPTION - -Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. - -To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." - -The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. - -Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsOnlineAudioConferencingRoutingPolicy -``` - -Retrieves all Online Audio Conferencing Routing Policy instances - -## PARAMETERS - -### -Filter - -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the Online Audio Conferencing Routing Policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) -[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) -[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) -[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Get-CsOnlineAudioConferencingRoutingPolicy +--- + +# Get-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet retrieves all online audio conferencing routing policies for the tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +```powershell +Get-CsOnlineAudioConferencingRoutingPolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsOnlineAudioConferencingRoutingPolicy +``` + +Retrieves all Online Audio Conferencing Routing Policy instances + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Get-CsOnlineAudioFile.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioFile.md similarity index 99% rename from teams/teams-ps/teams/Get-CsOnlineAudioFile.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioFile.md index 65d7fc94b4..df9b1d5db8 100644 --- a/teams/teams-ps/teams/Get-CsOnlineAudioFile.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineAudioFile.md @@ -1,14 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile applicable: Microsoft Teams -title: Get-CsOnlineAudioFile -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: - +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile +schema: 2.0.0 +title: Get-CsOnlineAudioFile --- # Get-CsOnlineAudioFile diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge.md index 8668124a9a..0d209da0de 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingBridge.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingBridge -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingBridge --- # Get-CsOnlineDialInConferencingBridge @@ -41,14 +43,14 @@ However, if the PSTN conferencing service status of the tenant is Disabled, no r ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineDialInConferencingBridge | fl ``` This example shows how to return all of the audio conferencing bridges that are being used and returns the results in a formatted list. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsOnlineDialInConferencingBridge -Tenant 26efe125-c070-46f9-8ed0-fc02165a167c ``` @@ -57,30 +59,47 @@ This example shows how to return all of the audio conferencing bridges for the g ## PARAMETERS -### -Identity -Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. +### -DomainController + +> Applicable: Skype for Business Online + +Specifies the domain controller that's used by the cmdlet to read or write the specified data. +Valid inputs for this parameter include: + +Fully qualified domain name (FQDN): + +`-DomainController atl-cs-001.Contoso.com` + +Computer name: + +`-DomainController atl-cs-001` + +This parameter is reserved for internal Microsoft use. ```yaml -Type: Guid +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: DC Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Specifies the name of the audio conferencing bridge. +### -Force + +> Applicable: Skype for Business Online + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -89,43 +108,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter include: - -Fully qualified domain name (FQDN): +### -Identity -`-DomainController atl-cs-001.Contoso.com` +> Applicable: Skype for Business Online -Computer name: - -`-DomainController atl-cs-001` - -This parameter is reserved for internal Microsoft use. +Specifies the globally-unique identifier (GUID) for the audio conferencing bridge. ```yaml -Type: Fqdn +Type: Guid Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Name + +> Applicable: Skype for Business Online + +Specifies the name of the audio conferencing bridge. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -135,13 +145,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -151,13 +163,15 @@ Accept wildcard characters: False ``` ### -TenantDomain + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported.md similarity index 95% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported.md index b8c773dd60..1fefa9da95 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingLanguagesSupported.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinglanguagessupported applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingLanguagesSupported -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinglanguagessupported +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingLanguagesSupported --- # Get-CsOnlineDialInConferencingLanguagesSupported @@ -30,7 +32,7 @@ When no languages are specified for a dial-in service number it will get the set ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsOnlineDialInConferencingLanguagesSupported | fl ``` @@ -40,6 +42,9 @@ This example allows returns the list of supported languages when you are using M ## PARAMETERS ### -DomainController + +> Applicable: Skype for Business Online + Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter include: @@ -51,7 +56,6 @@ Computer name: `-DomainController atl-cs-001` Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online Required: False Position: Named @@ -61,6 +65,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -69,7 +76,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber.md similarity index 97% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber.md index daa9adb621..46d200911a 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingservicenumber applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingServiceNumber -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingServiceNumber --- # Get-CsOnlineDialInConferencingServiceNumber @@ -54,21 +56,21 @@ A tenant administrator can only retrieve and view information that is associated ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialInConferencingServiceNumber | fl ``` This example returns all of the default service numbers for an organization in a formatted list. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineDialInConferencingServiceNumber -BridgeId 72dfe128-d079-46f8-8tr0-gb12369p167c | fl ``` This example returns all of the default service numbers for a specified audio conferencing bridge in a formatted list. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOnlineDialInConferencingBridge -Name "Conference Bridge" ``` @@ -94,8 +96,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the default dial-in service number string. +### -BridgeName +Specifies the name of the audio conferencing bridge. +When it is used it returns all of the service numbers that are configured on the audio conferencing bridge. ```yaml Type: String @@ -104,17 +107,18 @@ Aliases: applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -City +Specifies the city geocode to be used. +When used it lists all of the service numbers for a specific city geocode. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -126,13 +130,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantDomain -This parameter is reserved for internal Microsoft use. +### -DomainController +Specifies the domain controller that's used by the cmdlet to read or write the specified data. +Valid inputs for this parameter include: + +Fully qualified domain name (FQDN): `-DomainController atl-cs-001.Contoso.com.` + +Computer name: `-DomainController atl-cs-001` ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: +Aliases: DC applicable: Microsoft Teams Required: False @@ -142,12 +151,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeName -Specifies the name of the audio conferencing bridge. -When it is used it returns all of the service numbers that are configured on the audio conferencing bridge. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -159,9 +169,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -City -Specifies the city geocode to be used. -When used it lists all of the service numbers for a specific city geocode. +### -Identity +Specifies the default dial-in service number string. ```yaml Type: String @@ -170,24 +179,25 @@ Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter include: - -Fully qualified domain name (FQDN): `-DomainController atl-cs-001.Contoso.com.` +### -ResultSize +Specifies the number of records returned by the cmdlet. +For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. +Note that there is no way to guarantee which seven users will be returned. -Computer name: `-DomainController atl-cs-001` +The result size can be set to any whole number between 0 and 2147483647, inclusive. +If set to 0 the command will run, but no data will be returned. +If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error. ```yaml -Type: Fqdn +Type: Int32 Parameter Sets: (All) -Aliases: DC +Aliases: applicable: Microsoft Teams Required: False @@ -197,13 +207,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Tenant +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -215,17 +223,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResultSize -Specifies the number of records returned by the cmdlet. -For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. -Note that there is no way to guarantee which seven users will be returned. - -The result size can be set to any whole number between 0 and 2147483647, inclusive. -If set to 0 the command will run, but no data will be returned. -If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error. +### -TenantDomain +This parameter is reserved for internal Microsoft use. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings.md similarity index 97% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings.md index 5f1ea406de..5e08ffd8ae 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingTenantSettings.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingTenantSettings -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingTenantSettings --- # Get-CsOnlineDialInConferencingTenantSettings @@ -33,7 +35,7 @@ Get-CsOnlineDialInConferencingTenantSettings [-Tenant ] [-Filter ] ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialInConferencingTenantSettings ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingUser.md similarity index 99% rename from teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingUser.md index 7c7a3686cb..42a9461a3a 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialInConferencingUser.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencinguser applicable: Microsoft Teams -title: Get-CsOnlineDialInConferencingUser -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencinguser +schema: 2.0.0 +title: Get-CsOnlineDialInConferencingUser --- # Get-CsOnlineDialInConferencingUser @@ -43,7 +45,7 @@ The see a list of users with conferencing providers other than Microsoft use the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineDialInConferencingUser -Identity Ken.Myer@contoso.com ``` @@ -90,36 +92,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the user to retrieve. -The user can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceNumber +### -DomainController *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. -Specifies a service number to serve as a filter for the returned user collection. -Only users who have been assigned the specified number will be returned. -The service number can be specified in the following formats: E.164 number, +\ and tel:\. +This parameter is reserved for internal Microsoft use. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: +Aliases: DC applicable: Microsoft Teams Required: False @@ -129,16 +111,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -Force *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. -This parameter is reserved for internal Microsoft use. +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: DC +Aliases: applicable: Microsoft Teams Required: False @@ -148,22 +132,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force - -*This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. - -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Identity +Specifies the user to retrieve. +The user can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +You can also reference a user account by using the user's Active Directory distinguished name. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -212,6 +193,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ServiceNumber + +*This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. + +Specifies a service number to serve as a filter for the returned user collection. +Only users who have been assigned the specified number will be returned. +The service number can be specified in the following formats: E.164 number, +\ and tel:\. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. diff --git a/teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialOutPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialOutPolicy.md index 050f8fa643..9c1395fd30 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialOutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialoutpolicy applicable: Microsoft Teams -title: Get-CsOnlineDialOutPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialoutpolicy +schema: 2.0.0 +title: Get-CsOnlineDialOutPolicy --- # Get-CsOnlineDialOutPolicy diff --git a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy.md similarity index 97% rename from teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy.md index 44a0e83fd6..aaed34f797 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingpolicy applicable: Microsoft Teams -title: Get-CsOnlineDialinConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingpolicy +schema: 2.0.0 +title: Get-CsOnlineDialinConferencingPolicy --- # Get-CsOnlineDialinConferencingPolicy @@ -32,7 +34,7 @@ Retrieves the available Dial-in Conferencing policies in the tenant. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialinConferencingPolicy ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration.md similarity index 95% rename from teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration.md index 7c1dbe713c..437653ccdf 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDialinConferencingTenantConfiguration.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantconfiguration applicable: Microsoft Teams -title: Get-CsOnlineDialinConferencingTenantConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantconfiguration +schema: 2.0.0 +title: Get-CsOnlineDialinConferencingTenantConfiguration --- # Get-CsOnlineDialinConferencingTenantConfiguration ## SYNOPSIS Use the Get-CsOnlineDialinConferencingTenantConfiguration cmdlet to retrieve the tenant level configuration for dial-in conferencing. -The dial-in conferencing configuration specifies if dial-in conferencing is enabled for the tenant. ## SYNTAX @@ -42,7 +43,7 @@ There is one configuration per tenant. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDialinConferencingTenantConfiguration ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDirectoryTenant.md similarity index 98% rename from teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineDirectoryTenant.md index 35a0ee1afb..7420dcdfd5 100644 --- a/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineDirectoryTenant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedirectorytenant applicable: Microsoft Teams -title: Get-CsOnlineDirectoryTenant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedirectorytenant +schema: 2.0.0 +title: Get-CsOnlineDirectoryTenant --- # Get-CsOnlineDirectoryTenant @@ -28,7 +30,7 @@ Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve tenant parameters like An ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineDirectoryTenant -Tenant 7a205197-8e59-487d-b9fa-3fc1b108f1e5 ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md similarity index 98% rename from teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md index 4c7b04e076..e0f47c5e9b 100644 --- a/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineenhancedemergencyservicedisclaimer applicable: Microsoft Teams -title: Get-CsOnlineEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Get-CsOnlineEnhancedEmergencyServiceDisclaimer --- # Get-CsOnlineEnhancedEmergencyServiceDisclaimer @@ -26,7 +28,7 @@ You can use this cmdlet to determine whether your organization has accepted the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion "US" ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisCivicAddress.md similarity index 99% rename from teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisCivicAddress.md index 3a889df518..ff61fa229a 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisCivicAddress.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress applicable: Microsoft Teams -title: Get-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress +schema: 2.0.0 +title: Get-CsOnlineLisCivicAddress --- # Get-CsOnlineLisCivicAddress diff --git a/teams/teams-ps/teams/Get-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisLocation.md similarity index 93% rename from teams/teams-ps/teams/Get-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisLocation.md index 2fb1346e9a..f939c8b136 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation applicable: Microsoft Teams -title: Get-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation +schema: 2.0.0 +title: Get-CsOnlineLisLocation --- # Get-CsOnlineLisLocation @@ -79,69 +80,57 @@ This example returns the information on one location specified by its unique ide ## PARAMETERS -### -CivicAddressId -Specifies the identification number of the civic address that is associated with the target locations. +### -AssignmentStatus -```yaml -Type: Guid -Parameter Sets: UseCivicAddressId -Aliases: -Applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. -### -Location -Specifies an administrator defined description of the location to retrieve. -For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". +Specifies whether the retrieved locations have been assigned to users or not. +Valid inputs are "Assigned", or "Unassigned". ```yaml Type: String -Parameter Sets: UseLocation +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AssignmentStatus +### -City -**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. +> Applicable: Microsoft Teams -Specifies whether the retrieved locations have been assigned to users or not. -Valid inputs are "Assigned", or "Unassigned". +Specifies the city of the target location. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -City -Specifies the city of the target location. +### -CivicAddressId + +> Applicable: Microsoft Teams + +Specifies the identification number of the civic address that is associated with the target locations. ```yaml -Type: String -Parameter Sets: (All) +Type: Guid +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True @@ -149,13 +138,15 @@ Accept wildcard characters: False ``` ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies the country or region of the target location. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -165,13 +156,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the civic address that is associated with the target locations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -181,6 +174,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -189,7 +185,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -198,14 +193,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Location + +> Applicable: Microsoft Teams + +Specifies an administrator defined description of the location to retrieve. +For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". + +```yaml +Type: String +Parameter Sets: UseLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocationId + +> Applicable: Microsoft Teams + Specifies the unique identifier of the target location. ```yaml Type: Guid Parameter Sets: UseLocationId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -215,6 +231,9 @@ Accept wildcard characters: False ``` ### -NumberOfResultsToSkip + +> Applicable: Microsoft Teams + Specifies the number of results to skip. If there are a large number of locations, you can limit the number of results by using the ResultSize parameter. If you limited the first cmdlet execution to 25 results, and want to look at the next 25 locations, then you leave ResultSize at 25 and set NumberOfResultsToSkip to 25 to omit the first 25 you've reviewed. @@ -226,7 +245,6 @@ For example the command below will return locations 26-50 for Seattle. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -236,13 +254,15 @@ Accept wildcard characters: False ``` ### -PopulateNumberOfTelephoneNumbers + +> Applicable: Microsoft Teams + If present, the PopulateNumberOfTelephoneNumbers switch causes the cmdlet to provide the number of telephone numbers at the returned locations. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -252,13 +272,15 @@ Accept wildcard characters: False ``` ### -PopulateNumberOfVoiceUsers + +> Applicable: Microsoft Teams + If present, the PopulateNumberOfVoiceUsers switch causes the cmdlet to provide the number of voice users at the returned locations. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -268,13 +290,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Microsoft Teams + Specifies the maximum number of results to return. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -284,6 +308,9 @@ Accept wildcard characters: False ``` ### -ValidationStatus + +> Applicable: Microsoft Teams + Specifies the validation status of the addresses to be returned. Valid inputs are: Validated, Invalid, and Notvalidated. @@ -291,7 +318,6 @@ Valid inputs are: Validated, Invalid, and Notvalidated. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -309,7 +335,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Returns an instance, or instances of emergency location objects. +### PSObject +Returns an instance, or instances of emergency location objects. ## NOTES diff --git a/teams/teams-ps/teams/Get-CsOnlineLisPort.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisPort.md similarity index 89% rename from teams/teams-ps/teams/Get-CsOnlineLisPort.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisPort.md index 190850463c..e2a0b51f16 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisPort.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisPort.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport applicable: Microsoft Teams -title: Get-CsOnlineLisPort -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport +schema: 2.0.0 +title: Get-CsOnlineLisPort --- # Get-CsOnlineLisPort ## SYNOPSIS -Retrieves one or more ports from the location configuration database. Each port can be associated with a location, in which case this cmdlet will also retrieve the location information of the ports. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. +Retrieves one or more ports from the location configuration database. ## SYNTAX @@ -21,6 +22,8 @@ Get-CsOnlineLisPort [[-ChassisID] ] [-Force] [-IsDebug ] [-NCSApiU ``` ## DESCRIPTION +Each port can be associated with a location, in which case this cmdlet will also retrieve the location information of the ports. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + Enhanced 9-1-1 allows an emergency operator to identify the location of a caller without having to ask the caller for that information. In the case where a caller is calling from a Voice over Internet Protocol (VoIP) connection, that information must be extracted based on various connection factors. The VoIP administrator must configure a location map (called a wiremap) that will determine a caller's location. This cmdlet retrieves information on associations between physical locations and the port through which the client is connected. ## EXAMPLES @@ -53,13 +56,15 @@ Example 2 retrieves the location information for port G1/0/30 with ChassisID B8- ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -69,6 +74,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -77,7 +85,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -87,13 +94,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +112,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +130,15 @@ Accept wildcard characters: False ``` ### -PortID + +> Applicable: Microsoft Teams + This parameter identifies the ID of the port. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -135,13 +148,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSubnet.md similarity index 88% rename from teams/teams-ps/teams/Get-CsOnlineLisSubnet.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSubnet.md index 7aff6725b1..6ae9d003b9 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisSubnet.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelissubnet applicable: Microsoft Teams -title: Get-CsOnlineLisSubnet -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelissubnet +schema: 2.0.0 +title: Get-CsOnlineLisSubnet --- # Get-CsOnlineLisSubnet ## SYNOPSIS -Retrieves one or more subnets from the location configuration database. Each subnet can be associated with a location, in which case this cmdlet will also retrieve the location information of the subnets. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. +Retrieves one or more subnets from the location configuration database. ## SYNTAX @@ -22,27 +23,29 @@ Get-CsOnlineLisSubnet [[-TenantId] ] [[-Subnet] ] [-IsDebug ] [-Force] [-IsDebug ] [-NCSAp ``` ## DESCRIPTION +Each switch can be associated with a location, in which case this cmdlet will also retrieve the location information of the switches. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + Enhanced 9-1-1 allows an emergency operator to identify the location of a caller without having to ask the caller for that information. In the case where a caller is calling from a Voice over Internet Protocol (VoIP) connection, that information must be extracted based on various connection factors. The VoIP administrator must configure a location map (called a wiremap) that will determine a caller's location. This cmdlet retrieves information on associations between physical locations and the network switch through which the client is connected. ## EXAMPLES @@ -53,13 +56,15 @@ Example 2 retrieves Location Information Server (LIS) switch "B8-BE-BF-4A-A3-00" ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -69,6 +74,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -77,7 +85,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -87,13 +94,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +112,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +130,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint.md index a8526f7ab2..cc6a94ec58 100644 --- a/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineLisWirelessAccessPoint.md @@ -1,18 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint applicable: Microsoft Teams -title: Get-CsOnlineLisWirelessAccessPoint -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint +schema: 2.0.0 +title: Get-CsOnlineLisWirelessAccessPoint --- # Get-CsOnlineLisWirelessAccessPoint ## SYNOPSIS -Retrieves one or more wireless access points (WAPs) from the location configuration database. Each WAP can be associated with a location, in which case this cmdlet will also retrieve the location information of the WAPs. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. +Retrieves one or more wireless access points (WAPs) from the location configuration database. ## SYNTAX @@ -21,6 +22,8 @@ Get-CsOnlineLisWirelessAccessPoint [[-BSSID] ] [-Force] [-IsDebug ``` ## DESCRIPTION +Each WAP can be associated with a location, in which case this cmdlet will also retrieve the location information of the WAPs. This location association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + Enhanced 9-1-1 allows an emergency operator to identify the location of a caller without having to ask the caller for that information. In the case where a caller is calling from a Voice over Internet Protocol (VoIP) connection, that information must be extracted based on various connection factors. The VoIP administrator must configure a location map (called a wiremap) that will determine a caller's location. This cmdlet retrieves information on associations between physical locations and the WAP through which the client is connected. The BSSID (Basic Service Set Identifiers) is used to describe sections of a wireless local area network. It is the MAC of the 802.11 side of the access point. The BSSID parameter in this command also supports the wildcard format to cover all BSSIDs in the range which are sharing the same description and Location ID. The wildcard '*' can be on either the last one or two character(s). @@ -82,13 +85,15 @@ Example 4 retrieves Location Information Server (LIS) wireless access point "F0- ## PARAMETERS ### -BSSID + +> Applicable: Microsoft Teams + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. It can be presented in wildcard format. The wildcard '*' can be on either the last one or two character(s). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -106,7 +114,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePSTNGateway.md similarity index 96% rename from teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlinePSTNGateway.md index c7574f56ce..f22ade52eb 100644 --- a/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePSTNGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway applicable: Microsoft Teams -title: Get-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway +schema: 2.0.0 +title: Get-CsOnlinePSTNGateway --- # Get-CsOnlinePSTNGateway @@ -50,11 +51,12 @@ This example selects all SBCs with identities matching the pattern *.contoso.com ### -Filter +> Applicable: Microsoft Teams + ```yaml Type: String Parameter Sets: Filter Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -63,13 +65,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The parameter is optional for the cmdlet. If not set all SBCs paired to the tenant are listed. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None diff --git a/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePstnUsage.md similarity index 96% rename from teams/teams-ps/teams/Get-CsOnlinePstnUsage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlinePstnUsage.md index c70a50caf0..71f5c591bc 100644 --- a/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlinePstnUsage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstnusage applicable: Microsoft Teams -title: Get-CsOnlinePstnUsage -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstnusage +schema: 2.0.0 +title: Get-CsOnlinePstnUsage --- # Get-CsOnlinePstnUsage @@ -34,7 +35,7 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CSOnlinePSTNUsage ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSchedule.md similarity index 94% rename from teams/teams-ps/teams/Get-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineSchedule.md index 9b0227da05..0b231fbafe 100644 --- a/teams/teams-ps/teams/Get-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule applicable: Microsoft Teams -title: Get-CsOnlineSchedule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule +schema: 2.0.0 +title: Get-CsOnlineSchedule --- # Get-CsOnlineSchedule @@ -26,14 +28,14 @@ The Get-CsOnlineSchedule cmdlet returns information about the schedules in your ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineSchedule ``` This example retrieves all schedules that belong to your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineSchedule -Id "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineSipDomain.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSipDomain.md similarity index 98% rename from teams/teams-ps/teams/Get-CsOnlineSipDomain.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineSipDomain.md index 0627f86a2a..c68a566506 100644 --- a/teams/teams-ps/teams/Get-CsOnlineSipDomain.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineSipDomain.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain applicable: Microsoft Teams -title: Get-CsOnlineSipDomain -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain +schema: 2.0.0 +title: Get-CsOnlineSipDomain --- # Get-CsOnlineSipDomain diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumber.md similarity index 98% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumber.md index 0fced81daf..9815ebb22c 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber applicable: Microsoft Teams -title: Get-CsOnlineTelephoneNumber -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumber --- # Get-CsOnlineTelephoneNumber @@ -15,8 +16,6 @@ ms.reviewer: ## SYNOPSIS Use the `Get-CsOnlineTelephoneNumber` to retrieve telephone numbers from the Business Voice Directory. -**Note**: This cmdlet has been deprecated. Use the new [Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) cmdlet instead. For Microsoft 365 GCC High and DoD cloud instances use the new [Get-CshybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber) cmdlet instead. - ## SYNTAX ``` @@ -24,19 +23,22 @@ Get-CsOnlineTelephoneNumber [-ActivationState ] [-Assigned Get-CsOnlineTelephoneNumber -TelephoneNumber 19294450177 ``` This example gets the attributes of a specific phone number. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineTelephoneNumber -CapitalOrMajorCity NOAM-US-NY-NY ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberCountry.md similarity index 92% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberCountry.md index e2731e0eed..5fb2d6f3b2 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberCountry.md @@ -1,32 +1,33 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry -Module Name: MicrosoftTeams -title: Get-CsOnlineTelephoneNumberCountry -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumberCountry --- # Get-CsOnlineTelephoneNumberCountry ## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. +Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. ## SYNTAX ``` PS C:\> Get-CsOnlineTelephoneNumberCountry [] ``` -## DESCRIPTION +## DESCRIPTION Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineTelephoneNumberCountry ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberOrder.md similarity index 99% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberOrder.md index 5725171ad6..4911660bed 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberOrder.md @@ -1,13 +1,14 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: Get-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumberOrder --- # Get-CsOnlineTelephoneNumberOrder diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberType.md similarity index 93% rename from teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberType.md index 47c397e14b..7bc4cc9f1a 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineTelephoneNumberType.md @@ -1,19 +1,20 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype -Module Name: MicrosoftTeams -title: Get-CsOnlineTelephoneNumberType -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype +schema: 2.0.0 +title: Get-CsOnlineTelephoneNumberType --- # Get-CsOnlineTelephoneNumberType ## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. The telephone numbers can then be used to set up calling features for users and services in your organization. +Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. ## SYNTAX @@ -27,7 +28,7 @@ Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported te ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineTelephoneNumberType -Country US ``` @@ -54,7 +55,7 @@ RequiresCivicAddress : True This example returns the list of supported number offerings in United States. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineTelephoneNumberType -Country CA | ft NumberType ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineUser.md similarity index 97% rename from teams/teams-ps/teams/Get-CsOnlineUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineUser.md index 73ccb9f1c7..b61e2d3e9b 100644 --- a/teams/teams-ps/teams/Get-CsOnlineUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineuser applicable: Microsoft Teams -title: Get-CsOnlineUser -schema: 2.0.0 -manager: sshastri author: praspatil +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sshastri +Module Name: MicrosoftTeams ms.author: praspatil -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineuser +schema: 2.0.0 +title: Get-CsOnlineUser --- # Get-CsOnlineUser @@ -57,21 +58,21 @@ Users homed on Skype for Business Online will a TenantId that is equal to some v ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineUser ``` The command shown in Example 1 returns information for all the users configured as online users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineUser -Identity "sip:kenmyer@litwareinc.com" ``` In Example 2 information is returned for a single online user: the user with the SIP address "sip:kenmyer@litwareinc.com". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOnlineUser -Filter "ArchivingPolicy -eq 'RedmondArchiving'" ``` @@ -80,7 +81,7 @@ Example 3 uses the Filter parameter to limit the returned data to online users w To do this, the filter value {ArchivingPolicy -eq "RedmondArchiving"} is employed; that syntax limits returned data to users where the ArchivingPolicy property is equal to (-eq) "RedmondArchiving". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsOnlineUser -Filter {HideFromAddressLists -eq $True} ``` @@ -89,7 +90,7 @@ Example 4 returns information only for user accounts that have been configured s (That is, the Active Directory attribute msExchHideFromAddressLists is True.) To carry out this task, the Filter parameter is included along with the filter value {HideFromAddressLists -eq $True}. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234"} Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234,ext:"} @@ -98,14 +99,14 @@ Get-CsOnlineUser -Filter {LineURI -eq "1234"} Example 5 returns information for user accounts that have been assigned a designated phone number. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsOnlineUser -AccountType ResourceAccount ``` Example 6 returns information for user accounts that are categorized as resource accounts. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsOnlineUser -Filter "FeatureTypes -Contains 'PhoneSystem'" ``` @@ -136,6 +137,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Filter +Enables you to limit the returned data by filtering on specific attributes. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. + +The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. + +Examples: +- Get-CsOnlineUser -Filter {AssignedPlan -like "*MCO*"} +- Get-CsOnlineUser -Filter {UserPrincipalName -like "test*" -and (AssignedPlans -eq "MCOEV" -or AssignedPlans -like "MCOPSTN*")} +- Get-CsOnlineUser -Filter {OnPremHostingProvider -ne $null} +- Get-CsOnlineUser -Filter {WhenChanged -gt "1/25/2022 11:59:59 PM"} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the Identity of the user account to be retrieved. @@ -167,36 +192,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to limit the returned data by filtering on specific attributes. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. - -The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. - -Examples: -- Get-CsOnlineUser -Filter {AssignedPlan -like "*MCO*"} -- Get-CsOnlineUser -Filter {UserPrincipalName -like "test*" -and (AssignedPlans -eq "MCOEV" -or AssignedPlans -like "MCOPSTN*")} -- Get-CsOnlineUser -Filter {OnPremHostingProvider -ne $null} -- Get-CsOnlineUser -Filter {WhenChanged -gt "1/25/2022 11:59:59 PM"} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Properties -Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Identity, UserPrincipalName, Alias, AccountEnabled and DisplayName attributes will always be present in the output. Please note that only attributes available in the output of the Get-CsOnlineUser cmdlet can be selected. For a complete list of available attributes, refer to the response of the Get-CsOnlineUser cmdlet. +Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Identity, UserPrincipalName, Alias, AccountEnabled and DisplayName attributes will always be present in the output. Please note that only attributes available in the output of the Get-CsOnlineUser cmdlet can be selected. For a complete list of available attributes, refer to the response of the Get-CsOnlineUser cmdlet. Examples: -- Get-CsOnlineUser -Properties DisplayName, UserPrincipalName, FeatureTypes +- Get-CsOnlineUser -Properties DisplayName, UserPrincipalName, FeatureTypes - Get-CsOnlineUser -Properties DisplayName, Alias, LineURI ```yaml @@ -268,6 +269,8 @@ Accept wildcard characters: False ### -Sort +> Applicable: Microsoft Teams + Sorting is now enabled in Teams PowerShell Module by using the "-Sort" or "-OrderBy" parameters. For example: - Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" @@ -279,7 +282,6 @@ Sorting is now enabled in Teams PowerShell Module by using the "-Sort" or "-Orde Type: String Parameter Sets: (All) Aliases: OrderBy -Applicable: Microsoft Teams Required: False Position: Named @@ -326,11 +328,11 @@ A recent fix has addressed an issue where some Guest users were being omitted fr - PolicyType - which specifies the type of policy assigned (for example, TeamsMeetingPolicy, TeamsCallingPolicy, and so on.) - PolicyAssignment - which includes the display name of the assigned policy (displayName), the assignment type (assignmentType) indicating whether it is direct or group-based, the unique identifier of the policy (policyId), and the group identifier (groupId) if applicable. **Note**: The policyId property isn't currently supported. - + **Updates in Teams PowerShell Module**: - DialPlan: DialPlan attribute will be deprecated and no longer populated in the output of Get-CsOnlineUser in all clouds. - + **Updates in Teams PowerShell Module version 7.0.0 and later**: - OptionFlags: OptionFlags attribute will no longer be populated with value in the output of Get-CsOnlineUser in all clouds. It's important to note that other details besides EnterpriseVoiceEnabled, previously found in OptionFlags, are no longer relevant for Teams. Administrators can still utilize the EnterpriseVoiceEnabled attribute in the output of the Get-CsOnlineUser cmdlet to get this information. This change will be rolled out to all Teams Powershell Module versions. diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoute.md similarity index 88% rename from teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoute.md index 530da92267..3d9420d1dd 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoute.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute applicable: Microsoft Teams -title: Get-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute +schema: 2.0.0 +title: Get-CsOnlineVoiceRoute --- # Get-CsOnlineVoiceRoute ## SYNOPSIS -Returns information about the online voice routes configured for use in your tenant. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). +Returns information about the online voice routes configured for use in your tenant. ## SYNTAX @@ -36,28 +37,28 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineVoiceRoute ``` Retrieves the properties for all voice routes defined within the tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineVoiceRoute -Identity Route1 ``` Retrieves the properties for the Route1 voice route. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsOnlineVoiceRoute -Filter *test* ``` This command displays voice route settings where the Identity contains the string "test" anywhere within the value. To find the string test only at the end of the Identity, use the value \*test. Similarly, to find the string test only if it occurs at the beginning of the Identity, specify the value test\*. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> Get-CsOnlineVoiceRoute | Where-Object {$_.OnlinePstnGatewayList.Count -eq 0} ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy.md similarity index 91% rename from teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy.md index 1aec9c2d0a..9877cda52f 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceRoutingPolicy.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Get-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Get-CsOnlineVoiceRoutingPolicy --- # Get-CsOnlineVoiceRoutingPolicy ## SYNOPSIS -Returns information about the online voice routing policies configured for use in your tenant. Online voice routing policies manage online PSTN usages for users of Phone System. +Returns information about the online voice routing policies configured for use in your tenant. ## SYNTAX @@ -34,35 +35,35 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy ``` The command shown in Example 1 returns information for all the online voice routing policies configured for use in the tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" ``` In Example 2, information is returned for a single online voice routing policy: the policy with the Identity RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy -Filter "tag:*" ``` The command shown in Example 3 returns information about all the online voice routing policies configured at the per-user scope. To do this, the command uses the Filter parameter and the filter value "tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Long Distance"} ``` In Example 4, information is returned only for those online voice routing policies that include the PSTN usage "Long Distance". To carry out this task, the command first calls `Get-CsVoiceRoutingPolicy` without any parameters; that returns a collection of all the voice routing policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those policies where the OnlinePstnUsages property includes (-contains) the usage "Long Distance". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -notcontains "Long Distance"} ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceUser.md similarity index 99% rename from teams/teams-ps/teams/Get-CsOnlineVoiceUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceUser.md index 71f7ff2efb..9b31693cff 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoiceUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceuser applicable: Microsoft Teams -title: Get-CsOnlineVoiceUser -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceuser +schema: 2.0.0 +title: Get-CsOnlineVoiceUser --- # Get-CsOnlineVoiceUser @@ -81,7 +82,7 @@ In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Team ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsOnlineVoiceUser -Identity Ken.Myer@contoso.com ``` diff --git a/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailPolicy.md similarity index 94% rename from teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailPolicy.md index 844b74b828..26b3df0ff6 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy applicable: Microsoft Teams -title: Get-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy +schema: 2.0.0 +title: Get-CsOnlineVoicemailPolicy --- # Get-CsOnlineVoicemailPolicy @@ -32,21 +33,21 @@ This cmdlet retrieves information about one or more voicemail policies that have ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineVoicemailPolicy ``` In Example 1, the Get-CsOnlineVoicemailPolicy cmdlet is called without any additional parameters; this returns a collection of all the voicemail policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOnlineVoicemailPolicy -Identity TranscriptionDisabled ``` In Example 2, the Get-CsOnlineVoicemailPolicy cmdlet is used to return the per-user voicemail policy that has an Identity TranscriptionDisabled. Because identities are unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOnlineVoicemailPolicy -Filter "tag:*" ``` @@ -55,8 +56,8 @@ Example 3 uses the Filter parameter to return all the voicemail policies that ha ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. If this parameter is omitted, all voicemail policies available for use are returned. +### -Filter +This parameter accepts a wildcard string and returns all voicemail policies with identities matching that string. For example, a Filter value of Tag:* will return all preconfigured voicemail policy instances (excluding forest default "Global") available to use by the tenant admins. ```yaml Type: String @@ -65,13 +66,14 @@ Aliases: applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter accepts a wildcard string and returns all voicemail policies with identities matching that string. For example, a Filter value of Tag:* will return all preconfigured voicemail policy instances (excluding forest default "Global") available to use by the tenant admins. + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. If this parameter is omitted, all voicemail policies available for use are returned. ```yaml Type: String @@ -80,12 +82,11 @@ Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings.md similarity index 96% rename from teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings.md index b4437f7b08..9d65d7ace0 100644 --- a/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsOnlineVoicemailUserSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailusersettings applicable: Microsoft Teams -title: Get-CsOnlineVoicemailUserSettings -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailusersettings +schema: 2.0.0 +title: Get-CsOnlineVoicemailUserSettings --- # Get-CsOnlineVoicemailUserSettings @@ -26,7 +27,7 @@ The Get-CsOnlineVoicemailUserSettings cmdlet returns information about online vo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOnlineVoicemailUserSettings -Identity sip:user@contoso.com ``` @@ -35,33 +36,33 @@ This example gets the online voicemail user settings of user with SIP URI sip:us ## PARAMETERS -### -Identity -The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Identity +The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberAssignment.md similarity index 93% rename from teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberAssignment.md index 710ee1f968..5fafde0b5e 100644 --- a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberAssignment.md @@ -1,638 +1,668 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment -applicable: Microsoft Teams -title: Get-CsPhoneNumberAssignment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Get-CsPhoneNumberAssignment - -## SYNOPSIS -This cmdlet displays information about one or more phone numbers. - -## SYNTAX - -### Assignment (Default) -```powershell -Get-CsPhoneNumberAssignment [-ActivationState ] [-AssignedPstnTargetId ] [-AssignmentCategory ] - [-CapabilitiesContain ] [-CivicAddressId ] [-Filter ] [-IsoCountryCode ] - [-LocationId ] [-NetworkSiteId ] [-NumberType ] [-PstnAssignmentStatus ] [-Skip ] [-TelephoneNumber ] - [-TelephoneNumberContain ] [-TelephoneNumberGreaterThan ] [-TelephoneNumberLessThan ] - [-TelephoneNumberStartsWith ] [-Top ] [] -``` - -## DESCRIPTION -This cmdlet displays information about one or more phone numbers. You can filter the phone numbers to return by using different parameters. Returned results are sorted by TelephoneNumber in ascending order. Supported list of attributes for Filter are: -- TelephoneNumber -- OperatorId -- PstnAssignmentStatus (also supported AssignmentStatus) -- ActivationState -- IsoCountryCode -- Capability (also supported AcquiredCapabilities) -- IsOperatorConnect -- PstnPartnerName (also supported PartnerName) -- LocationId -- CivicAddressId -- NetworkSiteId -- NumberType -- AssignedPstnTargetId (also supported TargetId) -- TargetType -- AssignmentCategory -- ResourceAccountSharedCallingPolicySupported -- SupportedCustomerActions -- ReverseNumberLookup -- RoutingOptions -- SmsActivationState -- Tags - -If you are using both -Skip X and -Top Y for filtering, the returned results will first be skipped by X, and then the top Y results will be returned. - -By default, this cmdlet returns a maximum of 500 results. A maximum of 1000 results can be returned using -Top filter. If you need to get more than 1000 results, a combination of -Skip and -Top filtering can be used to list incremental returns of 1000 numbers. If a full list of telephone numbers acquired by the tenant is required, you can use [Export-CsAcquiredPhoneNumber](./export-csacquiredphonenumber.md) cmdlet to download a list of all acquired telephone numbers. - - -## EXAMPLES - -### Example 1 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumber +14025551234 -``` -```output -TelephoneNumber : +14025551234 -OperatorId : 2b24d246-a9ee-428b-96bc-fb9d9a053c8d -NumberType : CallingPlan -ActivationState : Activated -AssignedPstnTargetId : dc13d97b-7897-494e-bc28-6b469bf7a70e -AssignmentCategory : Primary -Capability : {UserAssignment} -City : Omaha -CivicAddressId : 703b30e5-dbdd-4132-9809-4c6160a6acc7 -IsoCountryCode : US -IsoSubdivision : Nebraska -LocationId : 407c17ae-8c41-431e-894a-38787c682f68 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : 7fc2f2eb-89aa-41d7-93de-73d015d22ff0 -PstnPartnerName : Microsoft -NumberSource : Online -ReverseNumberLookup : {} -Tag : {} -``` -This example displays information about the Microsoft Calling Plan subscriber phone number +1 (402) 555-1234. You can see that it is assigned to a user. - -### Example 2 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" -``` -```output -TelephoneNumber : +12065551000;ext=524 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -Tag : {} -``` -This example displays information about the Direct Routing phone number +1 (206) 555-1000;ext=524. You can see that it is assigned to a user. - -### Example 3 -```powershell -Get-CsPhoneNumberAssignment -CapabilitiesContain "VoiceApplicationAssignment,ConferenceAssignment" -``` -This example returns all phone numbers that have both the capability VoiceApplicationAssignment and the capability ConferenceAssignment assigned, but phone numbers that have only one of these capabilities assigned won't be returned. - -### Example 4 -```powershell -Get-CsPhoneNumberAssignment -AssignedPstnTargetId user1@contoso.com -``` -This example returns information about the phone number assigned to user1@contoso.com. - -### Example 5 -```powershell -Get-CsPhoneNumberAssignment -AssignedPstnTargetId aa1@contoso.com -``` -This example returns information about the phone number assigned to resource account aa1@contoso.com. - -### Example 6 -```powershell -Get-CsPhoneNumberAssignment -ActivationState Activated -CapabilitiesContain VoiceApplicationAssignment -PstnAssignmentStatus Unassigned -``` -This example returns information about all activated phone numbers with the capability VoiceApplicationAssignment that are not assigned. - -### Example 7 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumberContain "524" -``` -This example returns information about all phone numbers that contain the digits 524, including the phone number with extension 524 used in example 2. - -### Example 8 -```powershell -Get-CsPhoneNumberAssignment -Skip 1000 -Top 1000 -``` -This example returns all phone numbers sequenced between 1001 to 2000 in the record of phone numbers. - - -### Example 9 -```powershell -Get-CsPhoneNumberAssignment -AssignedPstnTargetId 'TeamsSharedCallingRoutingPolicy|Tag:SC1' -``` -This example returns all phone numbers assigned as emergency numbers in the Teams shared calling routing policy instance SC1. - -### Example 10 -```powershell -Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" -``` -```output -TelephoneNumber : +12065551000;ext=524 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a6f091 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {SkipInternalVoip} -Tag : {} -``` -This example displays when SkipInternalVoip option is turned on for a number. - -### Example 11 -```powershell -Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -eq '+12065551000'" -``` -```output -TelephoneNumber : +12065551000 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -Tag : {} -``` -This example shows a way to use -Filter parameter to display information of a specific number. - -### Example 12 -```powershell -Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -like '+12065551000' -and NumberType -eq 'DirectRouting'" -``` -```output -TelephoneNumber : +12065551000 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f591 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -Tag : {} -``` -This example shows a way to get filtered results using multiple Filter parameters. - -### Example 13 -```powershell -Get-CsPhoneNumberAssignment -Filter "Tags -contains ['Engineering']" -``` -```output -TelephoneNumber : +12065551102 -OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f071 -NumberType : DirectRouting -ActivationState : Activated -AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be -AssignmentCategory : Primary -Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : -CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : -LocationId : 00000000-0000-0000-0000-000000000000 -LocationUpdateSupported : True -NetworkSiteId : -PortInOrderStatus : -PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : -NumberSource : OnPremises -ReverseNumberLookup : {} -Tag : {Engineering} -``` -This example shows a way to get filtered results using tags. Tags are not case sensitive. - - -## PARAMETERS - -### -ActivationState -Filters the returned results based on the number type. Supported values are Activated, AssignmentPending, AssignmentFailed, UpdatePending, and UpdateFailed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignedPstnTargetId -Filters the returned results based on the user or resource account ID the phone number is assigned to. Supported values are UserPrincipalName, SIP address, ObjectId, and the Teams shared calling routing policy instance name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCategory -This parameter is used to differentiate between Primary and Private line assignment for a user. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapabilitiesContain -Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and TeamsPhoneMobile. - -If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like -ConferenceAssignment, VoiceApplicationAssignment you will get all phone numbers that have both capabilities assigned, but you won't get phone numbers that have only -VoiceApplicationAssignment or ConferenceAssignment assigned as capability. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CivicAddressId -Filters the returned results based on the CivicAddressId assigned to the phone number. You can get the CivicAddressId by using [Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -This can be used to filter on one or more parameters within the search results. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsoCountryCode -Filters the returned results based on the ISO 3166-1 Alpha-2 country code assigned to the phone number. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationId -Filters the returned results based on the LocationId assigned to the phone number. You can get the LocationId by using [Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSiteId -ID of a network site. A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberType -Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PstnAssignmentStatus -Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, ThirdPartyAppAssigned, and PolicyAssigned. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -Skips the first X returned results and the default value is 0. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumber -Filters the returned results to a specific phone number. It is optional to specify a prefixed "+". The phone number can't have "tel:" prefixed. -We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberContain - -Filters the returned results based on substring match for the specified string on TelephoneNumber. To search for a number with an extension, you need to specify -the digits of the extension. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberGreaterThan -Filters the returned results based on greater than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberLessThan to specify a -range of phone numbers to return results for. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberLessThan -Filters the returned results based on less than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberGreaterThan to specify a -range of phone numbers to return results for. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberStartsWith -Filters the returned results based on starts with string match for the specified string on TelephoneNumber. For supported formats see TelephoneNumber. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Top -Returns the first X returned results and the default value is 500. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### ActivationState -The activation state of the telephone number. - -### AssignedPstnTargetId -The ID of the object the phone number is assigned to, either the ObjectId of a user or resource account or the policy instance ID of a Teams shared calling routing policy instance. - -### AssignmentCategory -Contains the assignment category such as Primary or Private. - -### Capability -The list of capabilities assigned to the phone number. - -### City -The city where the phone number is located. - -### CivicAddressId -The ID of the CivicAddress assigned to the phone number. - -### IsoCountryCode -The ISO country code assigned to the phone number. - -### IsoSubDivision -The subdivision within the country/region assigned to the phone number, for example, the state for US phone numbers. - -### LocationId -The ID of the Location assigned to the phone number. - -### LocationUpdateSupported -Boolean stating if updating of the location assigned to the phone number is allowed. - -### NetworkSiteId -This parameter is reserved for internal Microsoft use. - -### NumberSource -The source of the phone number. Online for phone numbers assigned in Microsoft 365 and OnPremises for phone numbers assigned in AD on-premises and synchronized into Microsoft 365. - -### NumberType -The type of the phone number. - -### OperatorId -The ID of the operator. - -### PortInOrderStatus -The status of any port in order covering the phone number. - -### PstnAssignmentStatus -The assignment status of the phone number. - -### PstnPartnerId -The ID of the PSTN partner providing the phone number. - -### PstnPartnerName -The name of the PSTN partner. - -### TelephoneNumber -The phone number. The number is always displayed with prefixed "+", even if it was not assigned using prefixed "+". - -The object returned is of type SkypeTelephoneNumberMgmtCmdletAcquiredTelephoneNumber. - -### ReverseNumberLookup -Status of Reverse Number Lookup (RNL). When it is set to SkipInternalVoip, the calls are handled through external PSTN connection instead of internal VoIP lookup. - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. The parameter AssignmentCategory was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The output parameter NumberSource was introduced in Teams PowerShell module 5.7.0. - -The cmdlet is only available in commercial and GCC cloud instances. - -## RELATED LINKS -[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) - -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment +schema: 2.0.0 +title: Get-CsPhoneNumberAssignment +--- + +# Get-CsPhoneNumberAssignment + +## SYNOPSIS +This cmdlet displays information about one or more phone numbers. + +## SYNTAX + +### Assignment (Default) +```powershell +Get-CsPhoneNumberAssignment [-ActivationState ] [-AssignedPstnTargetId ] [-AssignmentCategory ] + [-CapabilitiesContain ] [-CivicAddressId ] [-Filter ] [-IsoCountryCode ] + [-LocationId ] [-NetworkSiteId ] [-NumberType ] [-PstnAssignmentStatus ] [-Skip ] [-TelephoneNumber ] + [-TelephoneNumberContain ] [-TelephoneNumberGreaterThan ] [-TelephoneNumberLessThan ] + [-TelephoneNumberStartsWith ] [-Top ] [] +``` + +## DESCRIPTION +This cmdlet displays information about one or more phone numbers. You can filter the phone numbers to return by using different parameters. Returned results are sorted by TelephoneNumber in ascending order. Supported list of attributes for Filter are: +- TelephoneNumber +- OperatorId +- PstnAssignmentStatus (also supported AssignmentStatus) +- ActivationState +- IsoCountryCode +- Capability (also supported AcquiredCapabilities) +- IsOperatorConnect +- PstnPartnerName (also supported PartnerName) +- LocationId +- CivicAddressId +- NetworkSiteId +- NumberType +- AssignedPstnTargetId (also supported TargetId) +- TargetType +- AssignmentCategory +- ResourceAccountSharedCallingPolicySupported +- SupportedCustomerActions +- ReverseNumberLookup +- RoutingOptions +- SmsActivationState +- Tags + +If you are using both -Skip X and -Top Y for filtering, the returned results will first be skipped by X, and then the top Y results will be returned. + +By default, this cmdlet returns a maximum of 500 results. A maximum of 1000 results can be returned using -Top filter. If you need to get more than 1000 results, a combination of -Skip and -Top filtering can be used to list incremental returns of 1000 numbers. If a full list of telephone numbers acquired by the tenant is required, you can use [Export-CsAcquiredPhoneNumber](./export-csacquiredphonenumber.md) cmdlet to download a list of all acquired telephone numbers. + + +## EXAMPLES + +### Example 1 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber +14025551234 +``` +```output +TelephoneNumber : +14025551234 +OperatorId : 2b24d246-a9ee-428b-96bc-fb9d9a053c8d +NumberType : CallingPlan +ActivationState : Activated +AssignedPstnTargetId : dc13d97b-7897-494e-bc28-6b469bf7a70e +AssignmentCategory : Primary +Capability : {UserAssignment} +City : Omaha +CivicAddressId : 703b30e5-dbdd-4132-9809-4c6160a6acc7 +IsoCountryCode : US +IsoSubdivision : Nebraska +LocationId : 407c17ae-8c41-431e-894a-38787c682f68 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : 7fc2f2eb-89aa-41d7-93de-73d015d22ff0 +PstnPartnerName : Microsoft +NumberSource : Online +ReverseNumberLookup : {} +Tag : {} +``` +This example displays information about the Microsoft Calling Plan subscriber phone number +1 (402) 555-1234. You can see that it is assigned to a user. + +### Example 2 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" +``` +```output +TelephoneNumber : +12065551000;ext=524 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +Tag : {} +``` +This example displays information about the Direct Routing phone number +1 (206) 555-1000;ext=524. You can see that it is assigned to a user. + +### Example 3 +```powershell +Get-CsPhoneNumberAssignment -CapabilitiesContain "VoiceApplicationAssignment,ConferenceAssignment" +``` +This example returns all phone numbers that have both the capability VoiceApplicationAssignment and the capability ConferenceAssignment assigned, but phone numbers that have only one of these capabilities assigned won't be returned. + +### Example 4 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId user1@contoso.com +``` +This example returns information about the phone number assigned to user1@contoso.com. + +### Example 5 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId aa1@contoso.com +``` +This example returns information about the phone number assigned to resource account aa1@contoso.com. + +### Example 6 +```powershell +Get-CsPhoneNumberAssignment -ActivationState Activated -CapabilitiesContain VoiceApplicationAssignment -PstnAssignmentStatus Unassigned +``` +This example returns information about all activated phone numbers with the capability VoiceApplicationAssignment that are not assigned. + +### Example 7 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumberContain "524" +``` +This example returns information about all phone numbers that contain the digits 524, including the phone number with extension 524 used in example 2. + +### Example 8 +```powershell +Get-CsPhoneNumberAssignment -Skip 1000 -Top 1000 +``` +This example returns all phone numbers sequenced between 1001 to 2000 in the record of phone numbers. + + +### Example 9 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId 'TeamsSharedCallingRoutingPolicy|Tag:SC1' +``` +This example returns all phone numbers assigned as emergency numbers in the Teams shared calling routing policy instance SC1. + +### Example 10 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" +``` +```output +TelephoneNumber : +12065551000;ext=524 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a6f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {SkipInternalVoip} +Tag : {} +``` +This example displays when SkipInternalVoip option is turned on for a number. + +### Example 11 +```powershell +Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -eq '+12065551000'" +``` +```output +TelephoneNumber : +12065551000 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +Tag : {} +``` +This example shows a way to use -Filter parameter to display information of a specific number. + +### Example 12 +```powershell +Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -like '+12065551000' -and NumberType -eq 'DirectRouting'" +``` +```output +TelephoneNumber : +12065551000 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f591 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +Tag : {} +``` +This example shows a way to get filtered results using multiple Filter parameters. + +### Example 13 +```powershell +Get-CsPhoneNumberAssignment -Filter "Tags -contains ['Engineering']" +``` +```output +TelephoneNumber : +12065551102 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f071 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +Tag : {Engineering} +``` +This example shows a way to get filtered results using tags. Tags are not case sensitive. + + +## PARAMETERS + +### -ActivationState + +> Applicable: Microsoft Teams + +Filters the returned results based on the number type. Supported values are Activated, AssignmentPending, AssignmentFailed, UpdatePending, and UpdateFailed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignedPstnTargetId + +> Applicable: Microsoft Teams + +Filters the returned results based on the user or resource account ID the phone number is assigned to. Supported values are UserPrincipalName, SIP address, ObjectId, and the Teams shared calling routing policy instance name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignmentCategory + +> Applicable: Microsoft Teams + +This parameter is used to differentiate between Primary and Private line assignment for a user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CapabilitiesContain + +> Applicable: Microsoft Teams + +Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and TeamsPhoneMobile. + +If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like +ConferenceAssignment, VoiceApplicationAssignment you will get all phone numbers that have both capabilities assigned, but you won't get phone numbers that have only +VoiceApplicationAssignment or ConferenceAssignment assigned as capability. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CivicAddressId + +> Applicable: Microsoft Teams + +Filters the returned results based on the CivicAddressId assigned to the phone number. You can get the CivicAddressId by using [Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +This can be used to filter on one or more parameters within the search results. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsoCountryCode + +> Applicable: Microsoft Teams + +Filters the returned results based on the ISO 3166-1 Alpha-2 country code assigned to the phone number. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationId + +> Applicable: Microsoft Teams + +Filters the returned results based on the LocationId assigned to the phone number. You can get the LocationId by using [Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteId + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberType + +> Applicable: Microsoft Teams + +Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PstnAssignmentStatus + +> Applicable: Microsoft Teams + +Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, ThirdPartyAppAssigned, and PolicyAssigned. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skips the first X returned results and the default value is 0. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +Filters the returned results to a specific phone number. It is optional to specify a prefixed "+". The phone number can't have "tel:" prefixed. +We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberContain + +> Applicable: Microsoft Teams + +Filters the returned results based on substring match for the specified string on TelephoneNumber. To search for a number with an extension, you need to specify +the digits of the extension. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberGreaterThan + +> Applicable: Microsoft Teams + +Filters the returned results based on greater than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberLessThan to specify a +range of phone numbers to return results for. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberLessThan + +> Applicable: Microsoft Teams + +Filters the returned results based on less than match for the specified string on TelephoneNumber. Can be used together with TelephoneNumberGreaterThan to specify a +range of phone numbers to return results for. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumberStartsWith + +> Applicable: Microsoft Teams + +Filters the returned results based on starts with string match for the specified string on TelephoneNumber. For supported formats see TelephoneNumber. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Top + +> Applicable: Microsoft Teams + +Returns the first X returned results and the default value is 500. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### ActivationState +The activation state of the telephone number. + +### AssignedPstnTargetId +The ID of the object the phone number is assigned to, either the ObjectId of a user or resource account or the policy instance ID of a Teams shared calling routing policy instance. + +### AssignmentCategory +Contains the assignment category such as Primary or Private. + +### Capability +The list of capabilities assigned to the phone number. + +### City +The city where the phone number is located. + +### CivicAddressId +The ID of the CivicAddress assigned to the phone number. + +### IsoCountryCode +The ISO country code assigned to the phone number. + +### IsoSubDivision +The subdivision within the country/region assigned to the phone number, for example, the state for US phone numbers. + +### LocationId +The ID of the Location assigned to the phone number. + +### LocationUpdateSupported +Boolean stating if updating of the location assigned to the phone number is allowed. + +### NetworkSiteId +This parameter is reserved for internal Microsoft use. + +### NumberSource +The source of the phone number. Online for phone numbers assigned in Microsoft 365 and OnPremises for phone numbers assigned in AD on-premises and synchronized into Microsoft 365. + +### NumberType +The type of the phone number. + +### OperatorId +The ID of the operator. + +### PortInOrderStatus +The status of any port in order covering the phone number. + +### PstnAssignmentStatus +The assignment status of the phone number. + +### PstnPartnerId +The ID of the PSTN partner providing the phone number. + +### PstnPartnerName +The name of the PSTN partner. + +### TelephoneNumber +The phone number. The number is always displayed with prefixed "+", even if it was not assigned using prefixed "+". + +The object returned is of type SkypeTelephoneNumberMgmtCmdletAcquiredTelephoneNumber. + +### ReverseNumberLookup +Status of Reverse Number Lookup (RNL). When it is set to SkipInternalVoip, the calls are handled through external PSTN connection instead of internal VoIP lookup. + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. The parameter AssignmentCategory was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The output parameter NumberSource was introduced in Teams PowerShell module 5.7.0. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) + +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Get-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberTag.md similarity index 96% rename from teams/teams-ps/teams/Get-CsPhoneNumberTag.md rename to teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberTag.md index beba5186cd..2e7e1f05b7 100644 --- a/teams/teams-ps/teams/Get-CsPhoneNumberTag.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPhoneNumberTag.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag applicable: Microsoft Teams -title: Get-CsPhoneNumberTag author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag schema: 2.0.0 +title: Get-CsPhoneNumberTag --- # Get-CsPhoneNumberTag diff --git a/teams/teams-ps/teams/Get-CsPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Get-CsPolicyPackage.md similarity index 98% rename from teams/teams-ps/teams/Get-CsPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsPolicyPackage.md index 0e3330e1af..c86a80799c 100644 --- a/teams/teams-ps/teams/Get-CsPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Get-CsPolicyPackage -author: serdarsoysal ms.author: serdars -manager: amitar online version: https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage schema: 2.0.0 +title: Get-CsPolicyPackage --- # Get-CsPolicyPackage @@ -66,13 +67,14 @@ Returns the set of policies in the Education_PrimaryStudent policy package. ### -Identity +> Applicable: Microsoft Teams + The name of a specific policy package. All possible policy package names can be found by running Get-CsPolicyPackage. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 0 Default value: None diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestStatus.md similarity index 99% rename from teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestStatus.md index 7152c35e07..9ed49ecffe 100644 --- a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestStatus.md @@ -1,10 +1,10 @@ --- +applicable: Microsoft Teams external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -online version: -title: Get-CsSdgBulkSignInRequestStatus schema: 2.0.0 +title: Get-CsSdgBulkSignInRequestStatus --- # Get-CsSdgBulkSignInRequestStatus diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestsSummary.md similarity index 98% rename from teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md rename to teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestsSummary.md index b1f9e93472..8f1d328eaa 100644 --- a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsSdgBulkSignInRequestsSummary.md @@ -1,10 +1,10 @@ --- +applicable: Microsoft Teams external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -online version: -title: Get-CsSdgBulkSignInRequestsSummary schema: 2.0.0 +title: Get-CsSdgBulkSignInRequestsSummary --- # Get-CsSdgBulkSignInRequestsSummary diff --git a/teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/Get-CsSharedCallQueueHistoryTemplate.md similarity index 91% rename from teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md rename to teams/teams-ps/MicrosoftTeams/Get-CsSharedCallQueueHistoryTemplate.md index eed80beb3f..8efc143077 100644 --- a/teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsSharedCallQueueHistoryTemplate.md @@ -1,39 +1,43 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsSharedCallQueueHistoryTemplate applicable: Microsoft Teams -title: Get-CsSharedCallQueueHistoryTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: Get-CsSharedCallQueueHistoryTemplate --- # Get-CsSharedCallQueueHistoryTemplate +## SYNOPSIS +Use the Get-CsSharedCallQueueHistory cmdlet to list the Shared Call Queue History templates. + ## SYNTAX -```powershell +``` Get-CsSharedCallQueueHistoryTemplate -Id [] ``` ## DESCRIPTION -Use the Get-CsSharedCallQueueHistory cmdlet to list the Shared Call Queue History templates +Use the Get-CsSharedCallQueueHistory cmdlet to list the Shared Call Queue History templates. > [!CAUTION] > This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsSharedCallQueueHistoryTemplate -Id 3a4b3d9b-91d8-4fbf-bcff-6907f325842c ``` This example retrieves the Shared Call Queue History Template with the Id `3a4b3d9b-91d8-4fbf-bcff-6907f325842c` -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsSharedCallQueueHistoryTemplate ``` @@ -86,6 +90,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsCallQueue](./Set-CsCallQueue.md) [Remove-CsCallQueue](./Remove-CsCallQueue.md) - - - diff --git a/teams/teams-ps/teams/Get-CsTeamTemplate.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplate.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplate.md index de8f75a2f2..7b7a92bab0 100644 --- a/teams/teams-ps/teams/Get-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplate.md @@ -1,244 +1,244 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate -title: Get-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: farahf -schema: 2.0.0 ---- - -# Get-CsTeamTemplate - -## SYNOPSIS - -This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. - -NOTE: The returned template definition is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. - -## SYNTAX - -### Get (Default) - -```powershell -Get-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] -``` - -### GetViaIdentity - -```powershell -Get-CsTeamTemplate -InputObject [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] -``` - -## DESCRIPTION - -This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Get-CsTeamTemplate -OdataId $_.OdataId} -``` - -Within the universe of templates the admin's tenant has access to, returns a template definition object (displayed as a JSON by default) for every custom and every Microsoft en-US template which names include 'test'. - -### EXAMPLE 2 - -```powershell -PS C:\> Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/cefcf333-91a9-43d0-919f-bbca5b7d2b24/Tenant/en-US' > 'config.json' -``` - -Saves the template with specified template ID as a JSON file. - -## PARAMETERS - -### -OdataId - -A composite URI of a template. - -```yaml -Type: String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - - `[Bssid ]`: - - `[ChassisId ]`: - - `[CivicAddressId ]`: Civic address id. - - `[Country ]`: - - `[GroupId ]`: The ID of a group whose policy assignments will be returned. - - `[Id ]`: - - `[Identity ]`: - - `[Locale ]`: - - `[LocationId ]`: Location id. - - `[OdataId ]`: A composite URI of a template. - - `[OperationId ]`: The ID of a batch policy assignment operation. - - `[OrderId ]`: - - `[PackageName ]`: The name of a specific policy package - - `[PolicyType ]`: The policy type for which group policy assignments will be returned. - - `[Port ]`: - - `[PortInOrderId ]`: - - `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. - - `[SubnetId ]`: - - `[TenantId ]`: - - `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -## RELATED LINKS - -[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) - -[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) - -[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) - -[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) - -[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: farahf +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate +schema: 2.0.0 +title: Get-CsTeamTemplate +--- + +# Get-CsTeamTemplate + +## SYNOPSIS + +This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + +## SYNTAX + +### Get (Default) + +```powershell +Get-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity + +```powershell +Get-CsTeamTemplate -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION + +This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + +NOTE: The returned template definition is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Get-CsTeamTemplate -OdataId $_.OdataId} +``` + +Within the universe of templates the admin's tenant has access to, returns a template definition object (displayed as a JSON by default) for every custom and every Microsoft en-US template which names include 'test'. + +### EXAMPLE 2 + +```powershell +PS C:\> Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/cefcf333-91a9-43d0-919f-bbca5b7d2b24/Tenant/en-US' > 'config.json' +``` + +Saves the template with specified template ID as a JSON file. + +## PARAMETERS + +### -Break + +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend + +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend + +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OdataId + +A composite URI of a template. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy + +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential + +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials + +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT \: Identity Parameter + - `[Bssid ]`: + - `[ChassisId ]`: + - `[CivicAddressId ]`: Civic address id. + - `[Country ]`: + - `[GroupId ]`: The ID of a group whose policy assignments will be returned. + - `[Id ]`: + - `[Identity ]`: + - `[Locale ]`: + - `[LocationId ]`: Location id. + - `[OdataId ]`: A composite URI of a template. + - `[OperationId ]`: The ID of a batch policy assignment operation. + - `[OrderId ]`: + - `[PackageName ]`: The name of a specific policy package + - `[PolicyType ]`: The policy type for which group policy assignments will be returned. + - `[Port ]`: + - `[PortInOrderId ]`: + - `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. + - `[SubnetId ]`: + - `[TenantId ]`: + - `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +## RELATED LINKS + +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) + +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) + +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) + +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) + +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Get-CsTeamTemplateList.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplateList.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamTemplateList.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplateList.md index c9928c4038..ff3d3de14e 100644 --- a/teams/teams-ps/teams/Get-CsTeamTemplateList.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamTemplateList.md @@ -1,147 +1,146 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist -title: Get-CsTeamTemplateList -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: farahf -schema: 2.0.0 ---- - -# Get-CsTeamTemplateList - -## SYNOPSIS - -This cmdlet supports retrieving information of all team templates available to your tenant, including both first party Microsoft team templates as well as custom templates. The templates information retrieved includes OData Id, template name, short description, count of channels and count of applications. -Note: All custom templates will be retrieved, regardless of the locale specification. If you have hidden templates in the admin center, you will still be able to see the hidden templates here. - -## SYNTAX - -### Get (Default) - -```powershell -Get-CsTeamTemplateList [[-PublicTemplateLocale] ] [] -``` - -### GetViaIdentity - -```powershell -Get-CsTeamTemplateList -InputObject [] -``` - -## DESCRIPTION - -Get a list of available team templates - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> Get-CsTeamTemplateList -``` - -Returns all en-US templates within the universe of templates the admin's tenant has access to. - -Note: All 1P Microsoft templates will always be returned in the specified locale. If the locale is not specified, en-US will be used. - -### EXAMPLE 2 - -```powershell -PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3 -``` - -Returns all en-US templates that have 3 channels within the universe of templates the admin's tenant has access to. - -## PARAMETERS - -### -PublicTemplateLocale - -The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US. - -```yaml -Type: String -Parameter Sets: Get -Aliases: - -Required: False -Position: 1 -Default value: 'en-US' -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateSummary - -## NOTES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties.\ -For information on hash tables, run Get-Help about_Hash_Tables.\ -\ -INPUTOBJECT \: Identity Parameter\ -\[Bssid \\]:\ -\[ChassisId \\]:\ -\[CivicAddressId \\]: Civic address id.\ -\[Country \\]:\ -\[GroupId \\]: The ID of a group whose policy assignments will be returned.\ -\[Id \\]:\ -\[Identity \\]:\ -\[Locale \\]: The language and country code of templates localization.\ -\[LocationId \\]: Location id.\ -\[OdataId \\]: A composite URI of a template.\ -\[OperationId \\]: The ID of a batch policy assignment operation.\ -\[OrderId \\]:\ -\[PackageName \\]: The name of a specific policy package\ -\[PolicyType \\]: The policy type for which group policy assignments will be returned.\ -\[Port \\]:\ -\[PortInOrderId \\]:\ -\[SubnetId \\]:\ -\[TenantId \\]:\ -\[UserId \\]: UserId.\ -Supports Guid.\ -Eventually UPN and SIP. - -## RELATED LINKS - -[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) - -[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) - -[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) - -[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) - -[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: farahf +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist +schema: 2.0.0 +title: Get-CsTeamTemplateList +--- + +# Get-CsTeamTemplateList + +## SYNOPSIS +Get a list of available team templates + +## SYNTAX + +### Get (Default) + +```powershell +Get-CsTeamTemplateList [[-PublicTemplateLocale] ] [] +``` + +### GetViaIdentity + +```powershell +Get-CsTeamTemplateList -InputObject [] +``` + +## DESCRIPTION + +This cmdlet supports retrieving information of all team templates available to your tenant, including both first party Microsoft team templates as well as custom templates. The templates information retrieved includes OData Id, template name, short description, count of channels and count of applications. +Note: All custom templates will be retrieved, regardless of the locale specification. If you have hidden templates in the admin center, you will still be able to see the hidden templates here. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> Get-CsTeamTemplateList +``` + +Returns all en-US templates within the universe of templates the admin's tenant has access to. + +Note: All 1P Microsoft templates will always be returned in the specified locale. If the locale is not specified, en-US will be used. + +### EXAMPLE 2 + +```powershell +PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3 +``` + +Returns all en-US templates that have 3 channels within the universe of templates the admin's tenant has access to. + +## PARAMETERS + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PublicTemplateLocale + +The language and country code of templates localization for Microsoft team templates. This will not be applied to your tenant custom team templates. Defaults to en-US. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: False +Position: 1 +Default value: 'en-US' +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateSummary + +## NOTES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties.\ +For information on hash tables, run Get-Help about_Hash_Tables.\ +\ +INPUTOBJECT \: Identity Parameter\ +\[Bssid \\]:\ +\[ChassisId \\]:\ +\[CivicAddressId \\]: Civic address id.\ +\[Country \\]:\ +\[GroupId \\]: The ID of a group whose policy assignments will be returned.\ +\[Id \\]:\ +\[Identity \\]:\ +\[Locale \\]: The language and country code of templates localization.\ +\[LocationId \\]: Location id.\ +\[OdataId \\]: A composite URI of a template.\ +\[OperationId \\]: The ID of a batch policy assignment operation.\ +\[OrderId \\]:\ +\[PackageName \\]: The name of a specific policy package\ +\[PolicyType \\]: The policy type for which group policy assignments will be returned.\ +\[Port \\]:\ +\[PortInOrderId \\]:\ +\[SubnetId \\]:\ +\[TenantId \\]:\ +\[UserId \\]: UserId.\ +Supports Guid.\ +Eventually UPN and SIP. + +## RELATED LINKS + +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) + +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) + +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) + +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) + +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAIPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAIPolicy.md index 77a631f12f..80fc1bc568 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: Andy447 external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-CsTeamsAIPolicy +ms.author: andywang online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsAIPolicy schema: 2.0.0 -author: Andy447 -ms.author: andywang +title: Get-CsTeamsAIPolicy --- # Get-CsTeamsAIPolicy @@ -38,31 +39,31 @@ Retrieves Teams AI policies and shows "EnrollFace", "EnrollVoice" and "SpeakerAt ## PARAMETERS -### -Identity -Identity of the Teams AI policy. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. -To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". +### -Identity +Identity of the Teams AI policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAcsFederationConfiguration.md similarity index 93% rename from teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAcsFederationConfiguration.md index 6ba81b228a..f1b05aeb2a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAcsFederationConfiguration.md @@ -1,22 +1,23 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsAcsFederationConfiguration -author: tomkau ms.author: tomkau online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration schema: 2.0.0 +title: Get-CsTeamsAcsFederationConfiguration --- # Get-CsTeamsAcsFederationConfiguration ## SYNOPSIS -This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. For more information, refer to [Azure Communication Services and Teams Interoperability](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). +This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. ## SYNTAX -```powershell +``` Get-CsTeamsAcsFederationConfiguration [-Identity ] [-Filter ] @@ -31,7 +32,7 @@ This cmdlet is used retrieve the Teams and ACS federation configuration for a Te You must be a Teams service admin or a Teams communication admin for your organization to run the cmdlet. -## Examples +## EXAMPLES ### Example 1 ```powershell diff --git a/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy.md index cc36983ff2..a1fea8a98d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppPermissionPolicy.md @@ -1,23 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsapppermissionpolicy applicable: Microsoft Teams -title: Get-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: mhayrapetyan +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsapppermissionpolicy +schema: 2.0.0 +title: Get-CsTeamsAppPermissionPolicy --- # Get-CsTeamsAppPermissionPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. - -As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . - -**This is only applicable for tenants who have not been migrated to ACM or UAM.** +As an admin, you can use app permission policies to allow or block apps for your users. ## SYNTAX @@ -33,10 +31,13 @@ Get-CsTeamsAppPermissionPolicy [-Tenant ] [-Filter ] [-Loca ``` ## DESCRIPTION + **NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppSetupPolicy.md similarity index 83% rename from teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppSetupPolicy.md index 47de4b4b99..8178eedf2f 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAppSetupPolicy.md @@ -1,24 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsappsetuppolicy applicable: Microsoft Teams -title: Get-CsTeamsAppSetupPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsappsetuppolicy +schema: 2.0.0 +title: Get-CsTeamsAppSetupPolicy --- # Get-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy.md index 77cad0be0c..9013489bba 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy -title: Get-CsTeamsAudioConferencingPolicy schema: 2.0.0 +title: Get-CsTeamsAudioConferencingPolicy --- # Get-CsTeamsAudioConferencingPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallHoldPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallHoldPolicy.md index 479035c0ea..c18cca2ff5 100644 --- a/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy applicable: Microsoft Teams -title: Get-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy +schema: 2.0.0 +title: Get-CsTeamsCallHoldPolicy --- # Get-CsTeamsCallHoldPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallParkPolicy.md similarity index 86% rename from teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallParkPolicy.md index e9b195959d..2cda31f88a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallParkPolicy.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallparkpolicy applicable: Microsoft Teams -title: Get-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallparkpolicy +schema: 2.0.0 +title: Get-CsTeamsCallParkPolicy --- # Get-CsTeamsCallParkPolicy ## SYNOPSIS - -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. - -NOTE: the call park feature is currently only available in the desktop and web clients. Call Park functionality is currently completely disabled in mobile clients. +The Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. ## SYNTAX @@ -34,6 +33,8 @@ Get-CsTeamsCallParkPolicy [-Tenant ] [-Filter ] [-LocalStor ## DESCRIPTION The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different phone. The Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. +NOTE: the call park feature is currently only available in the desktop and web clients. Call Park functionality is currently completely disabled in mobile clients. + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallingPolicy.md index 44a936109d..3a1314ea6d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsCallingPolicy.md @@ -1,14 +1,14 @@ --- +applicable: Microsoft Teams +author: serdarsoysal external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy -applicable: Microsoft Teams -title: Get-CsTeamsCallingPolicy schema: 2.0.0 -manager: bulenteg -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Get-CsTeamsCallingPolicy --- # Get-CsTeamsCallingPolicy @@ -53,8 +53,9 @@ Retrieves the calling policies with Identity starting with Sales. ## PARAMETERS -### -Identity -Specify the TeamsCallingPolicy that you would like to retrieve. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". ```yaml Type: String @@ -62,15 +63,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. -To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". +### -Identity +Specify the TeamsCallingPolicy that you would like to retrieve. ```yaml Type: String @@ -78,7 +78,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsChannelsPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsChannelsPolicy.md index 444867452e..67d8a599e8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsChannelsPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy applicable: Microsoft Teams -title: Get-CsTeamsChannelsPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy +schema: 2.0.0 +title: Get-CsTeamsChannelsPolicy --- # Get-CsTeamsChannelsPolicy @@ -42,35 +44,35 @@ Retrieves all policies related to Teams & Channels that are available in your or ## PARAMETERS -### -Identity -Specify the unique name of a policy you would like to retrieve. Use one of the following values: - -- `Global` -- The name of a custom policy you've created. If the value contains spaces, enclose the value in quotation marks ("). Note that the Identity value shows as `Tag:`, but the `` value also works. -- `Default`: This is a template that's used to populate the default property values when you create a new policy or to reset the property values in the global policy in case you delete it. Note that the Identity value shows as `Tag:Default`, but the `Default` value also works. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return a collection of all the per-user policies, use this syntax: -Filter "tag:". ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: String +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return a collection of all the per-user policies, use this syntax: -Filter "tag:". +### -Identity +Specify the unique name of a policy you would like to retrieve. Use one of the following values: + +- `Global` +- The name of a custom policy you've created. If the value contains spaces, enclose the value in quotation marks ("). Note that the Identity value shows as `Tag:`, but the `` value also works. +- `Default`: This is a template that's used to populate the default property values when you create a new policy or to reset the property values in the global policy in case you delete it. Note that the Identity value shows as `Tag:Default`, but the `Default` value also works. ```yaml -Type: String -Parameter Sets: Filter +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsClientConfiguration.md similarity index 85% rename from teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsClientConfiguration.md index 8ade0c1ba8..e2735cf413 100644 --- a/teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsClientConfiguration.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsclientconfiguration applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Get-CsTeamsClientConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsclientconfiguration +schema: 2.0.0 +title: Get-CsTeamsClientConfiguration --- # Get-CsTeamsClientConfiguration ## SYNOPSIS -The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and how Surface Hub devices can interact with Skype for Business meetings. This cmdlet allows IT admins to retrieve the effective configuration for their organization. +This cmdlet allows IT admins to retrieve the effective configuration for their organization. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication.md index a480bcadfc..11b0603bc9 100644 --- a/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsComplianceRecordingApplication.md @@ -1,20 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication applicable: Microsoft Teams -title: Get-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication +schema: 2.0.0 +title: Get-CsTeamsComplianceRecordingApplication --- # Get-CsTeamsComplianceRecordingApplication ## SYNOPSIS Returns information about the application instances of policy-based recording applications that have been configured for administering automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. ## SYNTAX @@ -32,6 +32,7 @@ Get-CsTeamsComplianceRecordingApplication [-Tenant ] [-Filter Applicable: Microsoft Teams + Policy instance name (optional). ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None diff --git a/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy.md similarity index 75% rename from teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy.md index 9a3a36317e..bd1d0312f4 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEducationAssignmentsAppPolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseducationassignmentsapppolicy applicable: Microsoft Teams -title: Get-CsTeamsEducationAssignmentsAppPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseducationassignmentsapppolicy +schema: 2.0.0 +title: Get-CsTeamsEducationAssignmentsAppPolicy --- # Get-CsTeamsEducationAssignmentsAppPolicy ## SYNOPSIS - -This policy is controlled by Global and Teams Service Administrators, and is used to turn on/off certain features only related to the Assignments Service, which runs for tenants with EDU licenses. This cmdlet allows you to retrieve the current values of your Education Assignments App Policy. At this time, you can only modify your global policy - this policy type does not support user-level custom policies. +This cmdlet allows you to retrieve the current values of your Education Assignments App Policy. ## SYNTAX @@ -32,7 +32,10 @@ Get-CsTeamsEducationAssignmentsAppPolicy [-Tenant ] [-Filter ] [] ``` ### Filter -```powershell + +``` Get-CsTeamsEducationConfiguration [-Filter ] [] ``` @@ -32,7 +35,7 @@ This cmdlet is used to retrieve the organization-wide education configuration fo You must be a Teams Service Administrator for your organization to run the cmdlet. -## Examples +## EXAMPLES ### Example 1 ```powershell diff --git a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy.md index 82cff25140..125ef456ae 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Get-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Get-CsTeamsEmergencyCallRoutingPolicy --- # Get-CsTeamsEmergencyCallRoutingPolicy @@ -55,31 +57,31 @@ Retrieves all emergency call routing policies with identity starting with Test. ## PARAMETERS -### -Identity -Specify the policy that you would like to retrieve. +### -Filter + Enables you to use wildcard characters when indicating the policy (or policies) to be returned. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter - Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +### -Identity +Specify the policy that you would like to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy.md index 2bae2ad08c..ea21aed0f1 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Get-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy schema: 2.0.0 +title: Get-CsTeamsEmergencyCallingPolicy --- # Get-CsTeamsEmergencyCallingPolicy @@ -72,31 +74,31 @@ This example displays extended notifications set on emergency calling policy wit ## PARAMETERS -### -Identity -Specify the policy that you would like to retrieve. +### -Filter +The Filter parameter allows you to limit the number of results based on filters on Identity you specify. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to limit the number of results based on filters on Identity you specify. +### -Identity +Specify the policy that you would like to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEnhancedEncryptionPolicy.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEnhancedEncryptionPolicy.md index d1c2fd903d..f2e34767ef 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEnhancedEncryptionPolicy.md @@ -1,111 +1,112 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy -title: Get-CsTeamsEnhancedEncryptionPolicy -author: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Get-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Returns information about the teams enhanced encryption policies configured for use in your organization. -## SYNTAX - -``` -Get-CsTeamsEnhancedEncryptionPolicy [-LocalStore] [[-Identity] ] [-Filter ] - [] -``` - -## DESCRIPTION -Returns information about the Teams enhanced encryption policies configured for use in your organization. -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -``` - -The command shown in Example 1 returns information for all the teams enhanced encryption policies configured for use in the tenant. - -### EXAMPLE 2 -```PowerShell -PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerEnhancedEncryptionPolicy' -``` - -In Example 2, information is returned for a single teams enhanced encryption policy: the policy with the Identity ContosoPartnerEnhancedEncryptionPolicy. - -## PARAMETERS - -### -LocalStore -Internal Microsoft use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed policies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Get-CsTeamsEnhancedEncryptionPolicy +--- + +# Get-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Returns information about the teams enhanced encryption policies configured for use in your organization. +## SYNTAX + +``` +Get-CsTeamsEnhancedEncryptionPolicy [-LocalStore] [[-Identity] ] [-Filter ] + [] +``` + +## DESCRIPTION +Returns information about the Teams enhanced encryption policies configured for use in your organization. +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> Get-CsTeamsEnhancedEncryptionPolicy +``` + +The command shown in Example 1 returns information for all the teams enhanced encryption policies configured for use in the tenant. + +### EXAMPLE 2 +```PowerShell +PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerEnhancedEncryptionPolicy' +``` + +In Example 2, information is returned for a single teams enhanced encryption policy: the policy with the Identity ContosoPartnerEnhancedEncryptionPolicy. + +## PARAMETERS + +### -Filter +If you don't know what policies have been pre-constructed, you can use filter to identify all policies available. This is a regex string against the name (Identity) of the pre-constructed policies. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Internal Microsoft use only. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEventsPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsEventsPolicy.md index db497af1ae..23b6fd229e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsEventsPolicy.md @@ -1,90 +1,91 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseventspolicy -title: Get-CsTeamsEventsPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsEventsPolicy - -## SYNOPSIS -Returns information about the Teams Events policy. Note that this policy is currently still in preview. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsEventsPolicy [[-Identity] ] [] -``` - -### Filter -``` -Get-CsTeamsEventsPolicy [-Filter ] [] -``` - -## DESCRIPTION -Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsEventsPolicy -``` - -Returns information for all Teams Events policies available for use in the tenant. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsEventsPolicy -Identity Global -``` - -Returns information for Teams Events policy with identity "Global". - -## PARAMETERS - -### -Filter -Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams Events policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseventspolicy +schema: 2.0.0 +title: Get-CsTeamsEventsPolicy +--- + +# Get-CsTeamsEventsPolicy + +## SYNOPSIS +Returns information about the Teams Events policy. Note that this policy is currently still in preview. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsEventsPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsEventsPolicy [-Filter ] [] +``` + +## DESCRIPTION +Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsEventsPolicy +``` + +Returns information for all Teams Events policies available for use in the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsEventsPolicy -Identity Global +``` + +Returns information for Teams Events policy with identity "Global". + +## PARAMETERS + +### -Filter +Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsExternalAccessConfiguration.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsExternalAccessConfiguration.md index ca976fe3ca..231cf2b1f3 100644 --- a/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsExternalAccessConfiguration.md @@ -1,15 +1,16 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsexternalaccessconfiguration -title: Get-CsTeamsExternalAccessConfiguration schema: 2.0.0 +title: Get-CsTeamsExternalAccessConfiguration --- # Get-CsTeamsExternalAccessConfiguration ## SYNOPSIS -The TeamsExternalAccessConfiguration contains all configurations that can be used to enhance the security of the entire organization, such as managing blocked users. This cmdlet returns the current settings of your organization. +This cmdlet returns the current settings of your organization. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFeedbackPolicy.md similarity index 97% rename from teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsFeedbackPolicy.md index 5000645a03..672f2c0fa5 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFeedbackPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Get-CsTeamsFeedbackPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfeedbackpolicy +schema: 2.0.0 +title: Get-CsTeamsFeedbackPolicy --- # Get-CsTeamsFeedbackPolicy @@ -42,31 +43,31 @@ In this example, we retrieve all the existing Teams feedback policies in the org ## PARAMETERS -### -Identity -The unique identifier of the policy. +### -Filter +Internal Microsoft use ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Internal Microsoft use +### -Identity +The unique identifier of the policy. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFilesPolicy.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsFilesPolicy.md index 0340a280a1..7bf6cbebdc 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFilesPolicy.md @@ -1,15 +1,16 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy -title: Get-CsTeamsFilesPolicy schema: 2.0.0 +title: Get-CsTeamsFilesPolicy --- # Get-CsTeamsFilesPolicy ## SYNOPSIS -Use the \`Get-CsTeamsFilesPolicy\` cmdlet to get a list of all pre-configured policy instances related to teams files. +Get a list of all pre-configured policy instances related to teams files. ## SYNTAX @@ -54,33 +55,33 @@ The filter value "tag:*" tells the Get-CsTeamsFilesPolicy cmdlet to return only ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. -If this parameter is omitted, all teams files policies available for use are returned. +### -Filter +This parameter accepts a wildcard string and returns all teams files policies with identities matching that string. +For example, a Filter value of Tag:* will return all preconfigured teams files policy instances (excluding forest default "Global") available to use by the tenant admins. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter accepts a wildcard string and returns all teams files policies with identities matching that string. -For example, a Filter value of Tag:* will return all preconfigured teams files policy instances (excluding forest default "Global") available to use by the tenant admins. +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. +If this parameter is omitted, all teams files policies available for use are returned. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md index 274a3a8171..33fbdc0377 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: pradas online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration -title: Get-CsTeamsFirstPartyMeetingTemplateConfiguration schema: 2.0.0 -author: boboPD -ms.author: pradas +title: Get-CsTeamsFirstPartyMeetingTemplateConfiguration --- # Get-CsTeamsFirstPartyMeetingTemplateConfiguration @@ -55,6 +56,8 @@ Fetches all the first-party templates on the tenant. ### -Identity +> Applicable: Microsoft Teams + This parameter can be used to fetch a specific instance of the configuration. Note: This configuration is read only and will only have the Global instance. @@ -63,7 +66,6 @@ Note: This configuration is read only and will only have the Global instance. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration.md index c14d3fbeec..57505f4e2f 100644 --- a/teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestCallingConfiguration.md @@ -1,13 +1,13 @@ --- +author: tomkau external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestcallingconfiguration +Locale: en-US +manager: bulenteg Module Name: MicrosoftTeams -title: Get-CsTeamsGuestCallingConfiguration -schema: 2.0.0 -author: tomkau ms.author: tomkau -manager: bulenteg -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestcallingconfiguration +schema: 2.0.0 +title: Get-CsTeamsGuestCallingConfiguration --- # Get-CsTeamsGuestCallingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration.md index fb9aee778f..3fe9a22a15 100644 --- a/teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMeetingConfiguration.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestmeetingconfiguration applicable: Microsoft Teams -title: Get-CsTeamsGuestMeetingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestmeetingconfiguration +schema: 2.0.0 +title: Get-CsTeamsGuestMeetingConfiguration --- # Get-CsTeamsGuestMeetingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration.md index c5dbf828bd..08a4209ed8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsGuestMessagingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestmessagingconfiguration applicable: Microsoft Teams -title: Get-CsTeamsGuestMessagingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestmessagingconfiguration +schema: 2.0.0 +title: Get-CsTeamsGuestMessagingConfiguration --- # Get-CsTeamsGuestMessagingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsIPPhonePolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsIPPhonePolicy.md index 4df635ab40..ee4e69176a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsipphonepolicy applicable: Microsoft Teams -title: Get-CsTeamsIPPhonePolicy author: tonywoodruff +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsipphonepolicy schema: 2.0.0 +title: Get-CsTeamsIPPhonePolicy --- # Get-CsTeamsIPPhonePolicy @@ -48,31 +49,31 @@ Retrieves the IP Phone Policy with name "CommonAreaPhone". ## PARAMETERS -### -Identity -Specify the unique name of the TeamsIPPhonePolicy that you would like to retrieve. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". +### -Identity +Specify the unique name of the TeamsIPPhonePolicy that you would like to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaConnectivityPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaConnectivityPolicy.md index 8c4debe867..29c2a907b1 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: lirunping-MSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-CsTeamsMediaConnectivityPolicy +ms.author: runli online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMediaConnectivityPolicy schema: 2.0.0 -author: lirunping-MSFT -ms.author: runli +title: Get-CsTeamsMediaConnectivityPolicy --- # Get-CsTeamsMediaConnectivityPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaLoggingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaLoggingPolicy.md index 85ecd6cb9c..178aa449e6 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMediaLoggingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy applicable: Microsoft Teams -title: Get-CsTeamsMediaLoggingPolicy author: LeoKuhorev -ms.author: leokukharau +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US manager: shalages +Module Name: MicrosoftTeams +ms.author: leokukharau +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy schema: 2.0.0 +title: Get-CsTeamsMediaLoggingPolicy --- # Get-CsTeamsMediaLoggingPolicy @@ -58,42 +59,42 @@ Return Teams Media Logging policy that is set for the entire tenant. ## PARAMETERS -### -Identity - -Unique identifier assigned to the Teams Media Logging policy. Note that Teams Media Logging policy has only one instance that has Identity "Enabled". +### -Filter -Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. +Enables using wildcards when specifying the policy (or policies) to be retrieved. +Note that you cannot use both the Filter and the Identity parameters in the same command. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables using wildcards when specifying the policy (or policies) to be retrieved. -Note that you cannot use both the Filter and the Identity parameters in the same command. +### -Identity + +Unique identifier assigned to the Teams Media Logging policy. Note that Teams Media Logging policy has only one instance that has Identity "Enabled". + +Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy.md index d7a61ce63f..e9894460c6 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Get-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # Get-CsTeamsMeetingBrandingPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration.md similarity index 87% rename from teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration.md index 973021d356..e4b50279f4 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastConfiguration.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbroadcastconfiguration applicable: Microsoft Teams -title: Get-CsTeamsMeetingBroadcastConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbroadcastconfiguration +schema: 2.0.0 +title: Get-CsTeamsMeetingBroadcastConfiguration --- # Get-CsTeamsMeetingBroadcastConfiguration ## SYNOPSIS -Get-CsTeamsMeetingBroadcastConfiguration \[\[-Identity\] \\] \[-Tenant \\] \[-ExposeSDNConfigurationJsonBlob \\] \[-LocalStore\] \[\\] - -Get-CsTeamsMeetingBroadcastConfiguration \[-Tenant \\] \[-ExposeSDNConfigurationJsonBlob \\] \[-Filter \\] \[-LocalStore\] \[\\] +Gets Tenant level configuration for broadcast events in Teams. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy.md index 0b2ca7c3cd..3e25d72215 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingBroadcastPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbroadcastpolicy applicable: Microsoft Teams -title: Get-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Get-CsTeamsMeetingBroadcastPolicy --- # Get-CsTeamsMeetingBroadcastPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingConfiguration.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingConfiguration.md index 3cd9448904..9f5e9ab068 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingconfiguration applicable: Microsoft Teams -title: Get-CsTeamsMeetingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingconfiguration +schema: 2.0.0 +title: Get-CsTeamsMeetingConfiguration --- # Get-CsTeamsMeetingConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingPolicy.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingPolicy.md index 3679deb1f5..e78b46de24 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy applicable: Microsoft Teams -title: Get-CsTeamsMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy +schema: 2.0.0 +title: Get-CsTeamsMeetingPolicy --- # Get-CsTeamsMeetingPolicy @@ -36,14 +38,14 @@ The Get-CsTeamsMeetingPolicy cmdlet enables you to return information about all ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsTeamsMeetingPolicy ``` In Example 1, Get-CsTeamsMeetingPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsTeamsMeetingPolicy -Identity SalesPolicy ``` @@ -51,7 +53,7 @@ Get-CsTeamsMeetingPolicy -Identity SalesPolicy In Example 2, Get-CsTeamsMeetingPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell Get-CsTeamsMeetingPolicy | Where-Object {$_.AllowMeetNow -eq $True} ``` @@ -60,7 +62,7 @@ The preceding command returns a collection of all the meeting policies where the To do this, Get-CsTeamsMeetingPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the AllowMeetNow property is equal to True. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell Get-CsTeamsMeetingPolicy -Identity Global | fl NewMeetingRecordingExpirationDays ``` diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplateConfiguration.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplateConfiguration.md index f5121f5202..109fdd0d1d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsMeetingTemplateConfiguration -author: boboPD ms.author: pradas online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplateConfiguration schema: 2.0.0 +title: Get-CsTeamsMeetingTemplateConfiguration --- # Get-CsTeamsMeetingTemplateConfiguration @@ -53,6 +54,8 @@ Fetches all the custom templates on the tenant. ### -Identity +> Applicable: Microsoft Teams + This parameter can be used to fetch a specific instance of the configuration. Note: This configuration is read only and will only have the Global instance. @@ -61,7 +64,6 @@ Note: This configuration is read only and will only have the Global instance. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplatePermissionPolicy.md index 22af122659..d22cd2c556 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Get-CsTeamsMeetingTemplatePermissionPolicy --- # Get-CsTeamsMeetingTemplatePermissionPolicy @@ -82,36 +83,38 @@ Note: _The "Tag:" prefix can be ignored when specifying the identity._ ## PARAMETERS -### -Identity +### -Filter -This parameter can be used to fetch a specific instance of the policy. +> Applicable: Microsoft Teams + +This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None Accept pipeline input: False -Accept wildcard characters: False +Accept wildcard characters: True ``` -### -Filter +### -Identity -This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. +> Applicable: Microsoft Teams + +This parameter can be used to fetch a specific instance of the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None Accept pipeline input: False -Accept wildcard characters: True +Accept wildcard characters: False ``` ### CommonParameters diff --git a/teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingPolicy.md index 8f998b1d2f..13865f06ae 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMessagingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy applicable: Microsoft Teams -title: Get-CsTeamsMessagingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy +schema: 2.0.0 +title: Get-CsTeamsMessagingPolicy --- # Get-CsTeamsMessagingPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMobilityPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMobilityPolicy.md index 3a147f9743..af65eda3db 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmobilitypolicy applicable: Microsoft Teams -title: Get-CsTeamsMobilityPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmobilitypolicy +schema: 2.0.0 +title: Get-CsTeamsMobilityPolicy --- # Get-CsTeamsMobilityPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMultiTenantOrganizationConfiguration.md similarity index 92% rename from teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsMultiTenantOrganizationConfiguration.md index 73ca7780ac..8bd94598f8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsMultiTenantOrganizationConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Get-CsTeamsMultiTenantOrganizationConfiguration -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmultitenantorganizationconfiguration -schema: 2.0.0 author: samlyu +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: samlyu +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmultitenantorganizationconfiguration +schema: 2.0.0 +title: Get-CsTeamsMultiTenantOrganizationConfiguration --- # Get-CsTeamsMultiTenantOrganizationConfiguration diff --git a/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy.md index f098d86971..e5aee01590 100644 --- a/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnetworkroamingpolicy applicable: Microsoft Teams -title: Get-CsTeamsNetworkRoamingPolicy author: TristanChen-msft -ms.author: jiaych -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnetworkroamingpolicy schema: 2.0.0 +title: Get-CsTeamsNetworkRoamingPolicy --- # Get-CsTeamsNetworkRoamingPolicy @@ -44,14 +44,14 @@ To enable the network roaming policy for users who are not Enterprise Voice enab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsTeamsNetworkRoamingPolicy ``` In Example 1, Get-CsTeamsNetworkRoamingPolicy is called without any additional parameters; this returns a collection of all the teams network roaming policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsTeamsNetworkRoamingPolicy -Identity OfficePolicy ``` @@ -61,13 +61,12 @@ Because identities are unique, this command will never return more than one item ## PARAMETERS -### -Identity -Unique identifier of the policy to be returned. -If this parameter is omitted, then all the Teams Network Roaming Policies configured for use in your organization will be returned. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False @@ -77,12 +76,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +### -Identity +Unique identifier of the policy to be returned. +If this parameter is omitted, then all the Teams Network Roaming Policies configured for use in your organization will be returned. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False diff --git a/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNotificationAndFeedsPolicy.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsNotificationAndFeedsPolicy.md index 95ac82e696..851c599609 100644 --- a/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsNotificationAndFeedsPolicy.md @@ -1,100 +1,101 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnotificationandfeedspolicy -title: Get-CsTeamsNotificationAndFeedsPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsNotificationAndFeedsPolicy - -## SYNOPSIS -Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. - -## SYNTAX - -### Identity (Default) -```powershell -Get-CsTeamsNotificationAndFeedsPolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter -```powershell -Get-CsTeamsNotificationAndFeedsPolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## DESCRIPTION -The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsNotificationAndFeedsPolicy -``` - -The command shown above returns information of all Teams NotificationAndFeedsPolicy that have been configured for use in the tenant. - -## PARAMETERS - -### -Filter -A filter that is not expressed in the standard wildcard language. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the policy when it was created. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnotificationandfeedspolicy +schema: 2.0.0 +title: Get-CsTeamsNotificationAndFeedsPolicy +--- + +# Get-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS +Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsNotificationAndFeedsPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter +```powershell +Get-CsTeamsNotificationAndFeedsPolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsNotificationAndFeedsPolicy +``` + +The command shown above returns information of all Teams NotificationAndFeedsPolicy that have been configured for use in the tenant. + +## PARAMETERS + +### -Filter +A filter that is not expressed in the standard wildcard language. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRecordingRollOutPolicy.md similarity index 97% rename from teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsRecordingRollOutPolicy.md index f4c168932c..71f6ecf726 100644 --- a/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- +applicable: Microsoft Teams +author: ronwa external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams +ms.author: ronwa online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsrecordingrolloutpolicy schema: 2.0.0 -applicable: Microsoft Teams title: Get-CsTeamsRecordingRollOutPolicy -manager: yujin1 -author: ronwa -ms.author: ronwa --- # Get-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md index d0da8be66e..0876c4dca5 100644 --- a/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,99 +1,102 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsroomvideoteleconferencingpolicy -title: Get-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsTeamsRoomVideoTeleConferencingPolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -Filter - -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The name the tenant admin gave to the Policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Get-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Get-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsRoomVideoTeleConferencingPolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## EXAMPLES + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The name the tenant admin gave to the Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSettingsCustomApp.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSettingsCustomApp.md index 74dc4c20ca..5a19571b68 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSettingsCustomApp.md @@ -1,83 +1,84 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp -title: Get-CsTeamsSettingsCustomApp -schema: 2.0.0 ---- - -# Get-CsTeamsSettingsCustomApp - -## SYNOPSIS -Get the Custom Apps Setting's value of Teams Admin Center. - -## SYNTAX - -``` -Get-CsTeamsSettingsCustomApp [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -There is a switch for managing Custom Apps in the Org-wide app settings page of Teams Admin Center. The command can get the current value of this switch. If the switch is enabled, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsSettingsCustomApp - -IsSideloadedAppsInteractionEnabled ----------------------------------- - False -``` - -Get the value of Custom Apps Setting. The value in the example is False, so custom apps are unavailable in the organization's app store. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[Set-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp +schema: 2.0.0 +title: Get-CsTeamsSettingsCustomApp +--- + +# Get-CsTeamsSettingsCustomApp + +## SYNOPSIS +Get the Custom Apps Setting's value of Teams Admin Center. + +## SYNTAX + +``` +Get-CsTeamsSettingsCustomApp [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +There is a switch for managing Custom Apps in the Org-wide app settings page of Teams Admin Center. The command can get the current value of this switch. If the switch is enabled, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsSettingsCustomApp + +IsSideloadedAppsInteractionEnabled +---------------------------------- + False +``` + +Get the value of Custom Apps Setting. The value in the example is False, so custom apps are unavailable in the organization's app store. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSharedCallingRoutingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSharedCallingRoutingPolicy.md index 817189ce6e..b40da012f8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- +applicable: Microsoft Teams +author: serdarsoysal external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy -applicable: Microsoft Teams -title: Get-CsTeamsSharedCallingRoutingPolicy schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: +title: Get-CsTeamsSharedCallingRoutingPolicy --- # Get-CsTeamsSharedCallingRoutingPolicy @@ -61,35 +60,35 @@ The command shown in Example 4 returns information about the Global policy insta ## PARAMETERS -### -Identity -Unique identifier of the Teams shared calling routing policy to be retrieved. - -You cannot use wildcard characters when specifying the Identity. If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsSharedCallingRoutingPolicy -returns all the Teams shared calling routing policies configured for use in the organization. +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. -To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". +### -Identity +Unique identifier of the Teams shared calling routing policy to be retrieved. + +You cannot use wildcard characters when specifying the Identity. If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsSharedCallingRoutingPolicy +returns all the Teams shared calling routing policies configured for use in the organization. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsAppPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsAppPolicy.md index e669a7e816..37c8ef1ddc 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsAppPolicy.md @@ -1,107 +1,108 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsapppolicy -title: Get-CsTeamsShiftsAppPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsShiftsAppPolicy - -## SYNOPSIS - -Returns information about the Teams Shifts App policies that have been configured for use in your organization. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsShiftsAppPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] -``` - -### Filter - -```powershell -Get-CsTeamsShiftsAppPolicy [-MsftInternalProcessingMode ] [-Filter ] [] -``` - -## DESCRIPTION - -The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsTeamsShiftsAppPolicy -``` - -Lists any available Teams Shifts Apps Policies. - -## PARAMETERS - -### -Filter - -This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique Identity assigned to the policy when it was created. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -{{ Fill MsftInternalProcessingMode Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsapppolicy +schema: 2.0.0 +title: Get-CsTeamsShiftsAppPolicy +--- + +# Get-CsTeamsShiftsAppPolicy + +## SYNOPSIS + +Returns information about the Teams Shifts App policies that have been configured for use in your organization. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsShiftsAppPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsTeamsShiftsAppPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsShiftsAppPolicy +``` + +Lists any available Teams Shifts Apps Policies. + +## PARAMETERS + +### -Filter + +This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique Identity assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnection.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnection.md index 5bfed6ecbd..c1dc5006f6 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: valk online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection schema: 2.0.0 +title: Get-CsTeamsShiftsConnection --- # Get-CsTeamsShiftsConnection @@ -109,6 +110,21 @@ Returns the connection with the specified -ConnectionId. ## PARAMETERS +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Break Wait for .NET debugger to attach. @@ -229,21 +245,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionConnector.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionConnector.md index b236e9c29c..7ffe80f58d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionConnector.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionConnector -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionConnector --- # Get-CsTeamsShiftsConnectionConnector diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionErrorReport.md similarity index 97% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionErrorReport.md index adf41720e0..084b39ee90 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionErrorReport.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionErrorReport -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionErrorReport --- # Get-CsTeamsShiftsConnectionErrorReport @@ -141,24 +142,10 @@ Returns the error report created after `2022-12-12T19:11:39.073Z`. ## PARAMETERS -### -ErrorReportId - -The ID of the error report. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Activeness +> Applicable: Microsoft Teams + The flag indicating results should have which activeness. Set this to `ActiveOnly` to get Error reports that are not resolved. Set this to `InactiveOnly` to get Error reports that are resolved. @@ -168,7 +155,6 @@ Set this to `Both` to get both active and inactive Error reports. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -176,15 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId +### -After -The UUID of a WFM connection. +> Applicable: Microsoft Teams + +The timestamp indicating results should be after which date and time. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -192,15 +179,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorInstanceId - -The UUID of a connector instance. +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Get Aliases: -Applicable: Microsoft Teams + Required: False Position: Named Default value: None @@ -208,15 +194,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamId +### -Before -The UUID of a team in Graph. +> Applicable: Microsoft Teams + +The timestamp indicating results should be before which date and time. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -224,15 +211,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Operation - -The name of the action of the controller or the name of the command. +### -Break +Wait for the .NET debugger to attach. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + Required: False Position: Named Default value: None @@ -240,15 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Procedure +### -Code -The name of the executing function or procedure. +> Applicable: Microsoft Teams + +The enum value of error code, human readable string defined in codebase. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -256,15 +243,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Code +### -ConnectionId -The enum value of error code, human readable string defined in codebase. +> Applicable: Microsoft Teams + +The UUID of a WFM connection. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -272,15 +260,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Before +### -ConnectorInstanceId -The timestamp indicating results should be before which date and time. +> Applicable: Microsoft Teams + +The UUID of a connector instance. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -288,15 +277,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -After +### -ErrorReportId -The timestamp indicating results should be after which date and time. +> Applicable: Microsoft Teams + +The ID of the error report. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -304,12 +294,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: Get +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: Required: False @@ -319,11 +309,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for the .NET debugger to attach. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: SwitchParameter +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -334,29 +324,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -InputObject +Identity Parameter ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -Operation + +> Applicable: Microsoft Teams + +The name of the action of the controller or the name of the command. ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -364,18 +356,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter +### -Procedure + +> Applicable: Microsoft Teams + +The name of the executing function or procedure. ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity +Type: String +Parameter Sets: (All) Aliases: - -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -423,6 +417,23 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamId + +> Applicable: Microsoft Teams + +The UUID of a team in Graph. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionInstance.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionInstance.md index 9cae80f516..4ce7a7dd43 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: leonardospina external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionInstance -author: leonardospina ms.author: lespina -manager: valk online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionInstance --- # Get-CsTeamsShiftsConnectionInstance diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionOperation.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionOperation.md index e1910f5da5..0f6cc6443d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionOperation.md @@ -1,31 +1,32 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionOperation -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionOperation --- # Get-CsTeamsShiftsConnectionOperation ## SYNOPSIS -This cmdlet gets the requested batch mapping operation. The batch mapping operation can be submitted by running [New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap). +This cmdlet gets the requested batch mapping operation. ## SYNTAX ### Get (Default) -```powershell +``` Get-CsTeamsShiftsConnectionOperation -OperationId [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` ### GetViaIdentity -```powershell +``` Get-CsTeamsShiftsConnectionOperation -InputObject [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] @@ -33,7 +34,7 @@ Get-CsTeamsShiftsConnectionOperation -InputObject Get-CsTeamsShiftsConnectionOperation -OperationId c79131b7-9ecb-484b-a8df-2959c7c1e5f2 ``` + ```output CreatedDateTime LastActionDateTime Id Status TenantId Type WfmConnectorInstanceId ---------------- ------------------ ----------- ------ -------- ---- ---------------------- -12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2959c7c1e5f2 NotStarted dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a TeamsMappingOperation WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a113e01 +--------------- ------------------ ----------- ------ -------- ---- ---------------------- +12/6/2021 7:28:51 PM 12/6/2021 7:28:51 PM c79131b7-9ecb-484b-a8df-2959c7c1e5f2 NotStarted dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a TeamsMappingOperation WCI-2afeb8ec-a0f6-4580-8f1e-85fd4a113e01 ``` Returns the details of batch mapping operation with ID `c79131b7-9ecb-484b-a8df-2959c7c1e5f2`. diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionSyncResult.md similarity index 97% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionSyncResult.md index d893f5cf7e..9df44f3aff 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionSyncResult.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionSyncResult -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionsyncresult schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionSyncResult --- # Get-CsTeamsShiftsConnectionSyncResult @@ -46,13 +47,14 @@ Returns the successful and failed users in the team mapping of Teams `12345d29-7 ### -ConnectorInstanceId +> Applicable: Microsoft Teams + The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -60,35 +62,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamId +### -InputObject -The Teams team ID. It can be retrieved by visiting [AzureAAD](https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). +The Identity parameter. ```yaml -Type: String -Parameter Sets: (All) +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -InputObject +### -TeamId -The Identity parameter. +> Applicable: Microsoft Teams + +The Teams team ID. It can be retrieved by visiting [AzureAAD](https://portal.azure.com/#blade/Microsoft_AAD_IAM/GroupsManagementMenuBlade/AllGroups). ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity +Type: String +Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionTeamMap.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionTeamMap.md index 7bdc708135..b9dc9896b6 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionTeamMap.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionTeamMap -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionTeamMap --- # Get-CsTeamsShiftsConnectionTeamMap @@ -51,13 +52,14 @@ In case of error, we can capture the error response as following: ### -ConnectorInstanceId +> Applicable: Microsoft Teams + The ID of the connection instance. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmTeam.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmTeam.md index f65e7c3eed..100e122ca8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmTeam.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionWfmTeam -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionWfmTeam --- # Get-CsTeamsShiftsConnectionWfmTeam @@ -107,62 +108,64 @@ Returns the WFM teams for the WFM connection with ID `a2d1b091-5140-4dd2-987a-98 ## PARAMETERS -### -ConnectorInstanceId - -The ID of the connection instance. You can retrieve it by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Get1, GetViaIdentity1 Aliases: -Applicable: Microsoft Teams -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId - -The ID of the connection. You can retrieve it by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -Break +Wait for the .NET debugger to attach. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. +### -ConnectionId + +> Applicable: Microsoft Teams + +The ID of the connection. You can retrieve it by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). ```yaml Type: String -Parameter Sets: Get1, GetViaIdentity1 +Parameter Sets: (All) Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for the .NET debugger to attach. +### -ConnectorInstanceId + +> Applicable: Microsoft Teams + +The ID of the connection instance. You can retrieve it by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmUser.md similarity index 97% rename from teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmUser.md index f32eda9d1a..8af9cadd65 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsConnectionWfmUser.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Get-CsTeamsShiftsConnectionWfmUser -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser schema: 2.0.0 +title: Get-CsTeamsShiftsConnectionWfmUser --- # Get-CsTeamsShiftsConnectionWfmUser @@ -49,13 +50,14 @@ Returns the users in the WFM team with ID `1000107` in the connection instances ### -ConnectorInstanceId +> Applicable: Microsoft Teams + The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -63,35 +65,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WfmTeamId +### -InputObject -The Teams team ID. It can be retrieved by running [Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam). +The identity parameter. ```yaml -Type: String -Parameter Sets: (All) +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -InputObject +### -WfmTeamId -The identity parameter. +> Applicable: Microsoft Teams + +The Teams team ID. It can be retrieved by running [Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam). ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: GetViaIdentity +Type: String +Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsPolicy.md index 05e0a5d12c..dac93ca485 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsShiftsPolicy.md @@ -1,99 +1,102 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamsshiftspolicy -title: Get-CsTeamsShiftsPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. - -## SYNTAX - -### Identity (Default) -```powershell -Get-CsTeamsShiftsPolicy [[-Identity] ] [] -``` - -### Filter -```powershell -Get-CsTeamsShiftsPolicy [-Filter ] [] -``` - -## DESCRIPTION -This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsShiftsPolicy -``` - -Gets the properties of all instances of the TeamsShiftPolicy. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -``` - -Gets the properties of the OffShiftAccessMessage1Always instance of the TeamsShiftPolicy. - -## PARAMETERS - -### -Identity -Policy instance name. Optional. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-teamsshiftspolicy +schema: 2.0.0 +title: Get-CsTeamsShiftsPolicy +--- + +# Get-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsShiftsPolicy [[-Identity] ] [] +``` + +### Filter +```powershell +Get-CsTeamsShiftsPolicy [-Filter ] [] +``` + +## DESCRIPTION +This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsPolicy +``` + +Gets the properties of all instances of the TeamsShiftPolicy. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always +``` + +Gets the properties of the OffShiftAccessMessage1Always instance of the TeamsShiftPolicy. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Microsoft Teams + +Policy instance name. Optional. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSipDevicesConfiguration.md similarity index 81% rename from teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSipDevicesConfiguration.md index bae35132f4..e0bd76220a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSipDevicesConfiguration.md @@ -1,11 +1,12 @@ --- +author: anmandav external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Get-CsTeamsSipDevicesConfiguration -author: anmandav ms.author: anmandav online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssipdevicesconfiguration schema: 2.0.0 +title: Get-CsTeamsSipDevicesConfiguration --- # Get-CsTeamsSipDevicesConfiguration @@ -16,7 +17,7 @@ This cmdlet is used to retrieve the organization-wide Teams SIP devices configur ## SYNTAX -```powershell +``` Get-CsTeamsSipDevicesConfiguration [] ``` @@ -26,7 +27,12 @@ This cmdlet is used to retrieve the organization-wide Teams SIP devices configur To execute the cmdlet, you need to hold a role within your organization such as Global Reader, Teams Administrator, or Teams Communication Administrator. -## Examples +## EXAMPLES + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ### Example 1 diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliance.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliance.md index e62879f6a5..f36e16f578 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliance.md @@ -1,95 +1,100 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliance -title: Get-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# Get-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsSurvivableBranchAppliance [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsTeamsSurvivableBranchAppliance [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## PARAMETERS - -### -Filter - -This parameter can be used to fetch instances based on partial matches on the Identity field. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the SBA. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliance +schema: 2.0.0 +title: Get-CsTeamsSurvivableBranchAppliance +--- + +# Get-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Gets the Survivable Branch Appliance (SBA) configured in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsSurvivableBranchAppliance [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsSurvivableBranchAppliance [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Filter + +This parameter can be used to fetch instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the SBA. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliancePolicy.md index c978c4c0a6..62e5d86ef8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,95 +1,100 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliancepolicy -title: Get-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Get-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] -``` - -### Filter - -```powershell -Get-CsTeamsSurvivableBranchAppliancePolicy [-MsftInternalProcessingMode ] [-Filter ] - [] -``` - -## PARAMETERS - -### -Filter - -This parameter can be used to fetch policy instances based on partial matches on the Identity field. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -This parameter can be used to fetch a specific instance of the policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Get-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Get-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Get the Survivable Branch Appliance (SBA) Policy defined in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +Get-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +``` +Get-CsTeamsSurvivableBranchAppliancePolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Filter + +This parameter can be used to fetch policy instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTargetingPolicy.md similarity index 89% rename from teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsTargetingPolicy.md index 8b48de854b..4734e7c47e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTargetingPolicy.md @@ -1,111 +1,109 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy -title: Get-CsTeamsTargetingPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsTargetingPolicy - -## SYNOPSIS - -The Teams Targeting Policy cmdlets enable administrators to control the type of Tenant tag setting that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsTargetingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] -``` - -### Filter - -```powershell -Get-CsTeamsTargetingPolicy [-MsftInternalProcessingMode ] [-Filter ] [] -``` - -## DESCRIPTION - -The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. - -The Get-CsTeamsTargetingPolicy cmdlet enables you to return information about all the Tenant tag setting policies that have been configured for use in your organization. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsTeamsTargetingPolicy -Identity SalesPolicy -``` - -In this example Get-CsTeamsTargetingPolicy is used to return the per-tenant tag policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. - -## PARAMETERS - -### -Filter - -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-tenant policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the tenant tag setting policies configured for use in your organization will be returned. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) -[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy +schema: 2.0.0 +title: Get-CsTeamsTargetingPolicy +--- + +# Get-CsTeamsTargetingPolicy + +## SYNOPSIS +The Get-CsTeamsTargetingPolicy cmdlet enables you to return information about all the Tenant tag setting policies that have been configured for use in your organization. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsTargetingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsTeamsTargetingPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsTargetingPolicy -Identity SalesPolicy +``` + +In this example Get-CsTeamsTargetingPolicy is used to return the per-tenant tag policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-tenant policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the tenant tag setting policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTemplatePermissionPolicy.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsTemplatePermissionPolicy.md index 783c5f16c2..ef334349cc 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTemplatePermissionPolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy -title: Get-CsTeamsTemplatePermissionPolicy author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy schema: 2.0.0 +title: Get-CsTeamsTemplatePermissionPolicy --- # Get-CsTeamsTemplatePermissionPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTranslationRule.md similarity index 96% rename from teams/teams-ps/teams/Get-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsTranslationRule.md index 402b525db2..9cbbb0d50c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule applicable: Microsoft Teams -title: Get-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule +schema: 2.0.0 +title: Get-CsTeamsTranslationRule --- # Get-CsTeamsTranslationRule @@ -55,32 +56,36 @@ This command will show Identity, Name, Description, Pattern, and Translation par ## PARAMETERS -### -Identity -Identifier of the specific translation rule to display. +### -Filter + +> Applicable: Microsoft Teams + +The filter to use against the Identity of translation rules. ```yaml Type: String -Parameter Sets: (Identity) +Parameter Sets: (Filter) Aliases: -Applicable: Microsoft Teams Required: False -Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The filter to use against the Identity of translation rules. +### -Identity + +> Applicable: Microsoft Teams + +Identifier of the specific translation rule to display. ```yaml Type: String -Parameter Sets: (Filter) +Parameter Sets: (Identity) Aliases: -Applicable: Microsoft Teams Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUnassignedNumberTreatment.md similarity index 94% rename from teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUnassignedNumberTreatment.md index cd8a81e96e..f18d906658 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUnassignedNumberTreatment.md @@ -1,105 +1,106 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment -applicable: Microsoft Teams -title: Get-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Get-CsTeamsUnassignedNumberTreatment - -## SYNOPSIS -Displays a specific or all treatments for how calls to an unassigned number range should be routed. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsUnassignedNumberTreatment [[-Identity] ] [] -``` - -### Filter -``` -Get-CsTeamsUnassignedNumberTreatment [-Filter ] [] -``` - -## DESCRIPTION -This cmdlet displays a specific or all treatments for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsTeamsUnassignedNumberTreatment -Identity MainAA -``` -This example displays the treatment MainAA. - -### Example 2 -```powershell -Get-CsTeamsUnassignedNumberTreatment -``` -This example displays all configured treatments. - -### Example 3 -```powershell -Get-CsTeamsUnassignedNumberTreatment -Filter Ann* -``` -This example displays all configured treatments with an Identity starting with Ann. - -## PARAMETERS - -### -Filter -Enables you to limit the returned data by filtering on the Identity attribute. - -```yaml -Type: String -Parameter Sets: (Filter) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Id of the specific treatment to show. - -```yaml -Type: System.String -Parameter Sets: (Identity) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.5.1 or later. - -## RELATED LINKS -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) - -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) - -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment +schema: 2.0.0 +title: Get-CsTeamsUnassignedNumberTreatment +--- + +# Get-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +Displays a specific or all treatments for how calls to an unassigned number range should be routed. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsUnassignedNumberTreatment [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsUnassignedNumberTreatment [-Filter ] [] +``` + +## DESCRIPTION +This cmdlet displays a specific or all treatments for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsTeamsUnassignedNumberTreatment -Identity MainAA +``` +This example displays the treatment MainAA. + +### Example 2 +```powershell +Get-CsTeamsUnassignedNumberTreatment +``` +This example displays all configured treatments. + +### Example 3 +```powershell +Get-CsTeamsUnassignedNumberTreatment -Filter Ann* +``` +This example displays all configured treatments with an Identity starting with Ann. + +## PARAMETERS + +### -Filter + +> Applicable: Microsoft Teams + +Enables you to limit the returned data by filtering on the Identity attribute. + +```yaml +Type: String +Parameter Sets: (Filter) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the specific treatment to show. + +```yaml +Type: System.String +Parameter Sets: (Identity) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +## RELATED LINKS +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) + +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpdateManagementPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpdateManagementPolicy.md index 3bcd814b61..b07f2a2678 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- +applicable: Microsoft Teams +author: vargasj-ms external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: gnamun Module Name: MicrosoftTeams +ms.author: vargasj online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsupdatemanagementpolicy -applicable: Microsoft Teams -title: Get-CsTeamsUpdateManagementPolicy schema: 2.0.0 -author: vargasj-ms -ms.author: vargasj -manager: gnamun +title: Get-CsTeamsUpdateManagementPolicy --- # Get-CsTeamsUpdateManagementPolicy @@ -42,32 +43,32 @@ In this example, we retrieve all the existing Teams Update Management policies i ## PARAMETERS -### -Identity -The unique identifier of the policy. +### -Filter + +This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter - -This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. +### -Identity +The unique identifier of the policy. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradeConfiguration.md similarity index 91% rename from teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradeConfiguration.md index 7443bce227..4d9d1c3752 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradeConfiguration.md @@ -1,19 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration applicable: Microsoft Teams -title: Get-CsTeamsUpgradeConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration +schema: 2.0.0 +title: Get-CsTeamsUpgradeConfiguration --- # Get-CsTeamsUpgradeConfiguration ## SYNOPSIS -Returns information related to managing the upgrade to Teams from Skype for Business. TeamsUpgradeConfiguration should be used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. For Office 365 users, it allows administrators to determine which application end users should use to join Skype for Business meetings. +Returns information related to managing the upgrade to Teams from Skype for Business. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradePolicy.md similarity index 88% rename from teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradePolicy.md index 1da715da85..017b0fcd60 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsUpgradePolicy.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy applicable: Microsoft Teams -title: Get-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy +schema: 2.0.0 +title: Get-CsTeamsUpgradePolicy --- # Get-CsTeamsUpgradePolicy ## SYNOPSIS -TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. - -> [!IMPORTANT] -> It can take up to 24 hours for a change to TeamsUpgradePolicy to take effect. Before then, user presence status may not be correct (may show as **Unknown**). +This cmdlet returns the set of instances of this policy. ## SYNTAX @@ -31,7 +30,11 @@ Get-CsTeamsUpgradePolicy [-Tenant ] [-Filter ] [-LocalStore] [ [!IMPORTANT] +> It can take up to 24 hours for a change to TeamsUpgradePolicy to take effect. Before then, user presence status may not be correct (may show as **Unknown**). + NOTES: - Except for on-premise versions of Skype for Business Server, all relevant instances of TeamsUpgradePolicy are built into the system, so there is no corresponding New cmdlet. @@ -127,37 +130,37 @@ List all on-premises instances (if any) of TeamsUpgradePolicy. ## PARAMETERS -### -Identity -If identity parameter is passed, this will return a specific instance. If no identity parameter is specified, the cmdlet returns all instances. +### -Filter +{{Fill Filter Description}} ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -{{Fill Filter Description}} + +### -Identity +If identity parameter is passed, this will return a specific instance. If no identity parameter is specified, the cmdlet returns all instances. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### -Tenant {{Fill Tenant Description}} diff --git a/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVdiPolicy.md similarity index 85% rename from teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVdiPolicy.md index 41be427ab3..f39d9b7b16 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVdiPolicy.md @@ -1,99 +1,100 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvdipolicy -title: Get-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsVdiPolicy - -## SYNOPSIS -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -### Identity (Default) -```powershell -Get-CsTeamsVdiPolicy [[-Identity] ] [] -``` - -### Filter -```powershell -Get-CsTeamsVdiPolicy [-Filter ] [] -``` - -## DESCRIPTION -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -Teams Vdi policies can be configured at the global and per-user scopes. The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsVdiPolicy -``` - -In Example 1, Get-CsTeamsVdiPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsVdiPolicy -Identity SalesPolicy -``` - -In Example 2, Get-CsTeamsVdiPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identites are unique, this command will never return more than one item. - -### Example 3 -```powershell -PS C:\> Get-CsTeamsVdiPolicy | where-Object {$_.VDI2Optimization -eq "Enabled"} -``` - -The preceding command returns a collection of all the meeting policies where the VDI2Optimization property is Enabled. To do this, Get-CsTeamsVdiPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the VDI2Optimization property is equal to Enabled. - -## PARAMETERS - -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvdipolicy +schema: 2.0.0 +title: Get-CsTeamsVdiPolicy +--- + +# Get-CsTeamsVdiPolicy + +## SYNOPSIS +The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsVdiPolicy [[-Identity] ] [] +``` + +### Filter +```powershell +Get-CsTeamsVdiPolicy [-Filter ] [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +Teams Vdi policies can be configured at the global and per-user scopes. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsVdiPolicy +``` + +In Example 1, Get-CsTeamsVdiPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsVdiPolicy -Identity SalesPolicy +``` + +In Example 2, Get-CsTeamsVdiPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identites are unique, this command will never return more than one item. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsVdiPolicy | where-Object {$_.VDI2Optimization -eq "Enabled"} +``` + +The preceding command returns a collection of all the meeting policies where the VDI2Optimization property is Enabled. To do this, Get-CsTeamsVdiPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the VDI2Optimization property is equal to Enabled. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy.md similarity index 79% rename from teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy.md index be0b2b593d..f3d3420a4d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVideoInteropServicePolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvideointeropservicepolicy applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Get-CsTeamsVideoInteropServicePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvideointeropservicepolicy +schema: 2.0.0 +title: Get-CsTeamsVideoInteropServicePolicy --- # Get-CsTeamsVideoInteropServicePolicy ## SYNOPSIS - -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. +The Get-CsTeamsVideoInteropServicePolicy cmdlet allows you to identify the pre-constructed policies that you can use in your organization. ## SYNTAX @@ -32,9 +32,12 @@ Get-CsTeamsVideoInteropServicePolicy [-Tenant ] [-Filter ] ``` ## DESCRIPTION -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. Microsoft provides pre-constructed policies for each of our supported partners that allow you to designate which partner(s) to use for cloud video interop. - -The Get-CsTeamsVideoInteropServicePolicy cmdlet allows you to identify the pre-constructed policies that you can use in your organization. You can assign this policy to one or more of your users leveraging the Grant-CsTeamsVideoInteropServicePolicy cmdlet. +Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You +can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular +users or for your entire organization. Microsoft provides pre-constructed policies for each of our +supported partners that allow you to designate which partner(s) to use for cloud video interop. You +can assign this policy to one or more of your users leveraging the +Grant-CsTeamsVideoInteropServicePolicy cmdlet. ## EXAMPLES diff --git a/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVirtualAppointmentsPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVirtualAppointmentsPolicy.md index 5d698766b8..884f86a21b 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams +ms.author: erocha online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy -title: Get-CsTeamsVirtualAppointmentsPolicy schema: 2.0.0 -ms.author: erocha -manager: sonaggarwal -author: emmanuelrocha001 +title: Get-CsTeamsVirtualAppointmentsPolicy --- # Get-CsTeamsVirtualAppointmentsPolicy diff --git a/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVoiceApplicationsPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsVoiceApplicationsPolicy.md index 0a73f7a287..dc1aaf3231 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy -title: Get-CsTeamsVoiceApplicationsPolicy schema: 2.0.0 +title: Get-CsTeamsVoiceApplicationsPolicy --- # Get-CsTeamsVoiceApplicationsPolicy @@ -51,6 +52,23 @@ The command shown in Example 3 returns information about all the Teams voice app ## PARAMETERS +### -Filter +Enables you to use wildcards when retrieving one or more Teams voice applications policies. For example, to return all the policies configured at the per-user scope, use this syntax: + +-Filter "tag:*" + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier of the Teams voice applications policy to be retrieved. To return the global policy, use this syntax: @@ -76,23 +94,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when retrieving one or more Teams voice applications policies. For example, to return all the policies configured at the per-user scope, use this syntax: - --Filter "tag:*" - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLoadPolicy.md similarity index 95% rename from teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLoadPolicy.md index 894f122d6b..ffbea4821d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLoadPolicy.md @@ -1,115 +1,116 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy -title: Get-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Get-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsWorkLoadPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] -``` - -### Filter - -```powershell -Get-CsTeamsWorkLoadPolicy [-MsftInternalProcessingMode ] [-Filter ] [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsTeamsWorkLoadPolicy -``` - -Retrieves the Teams Workload Policy instances and shows assigned values. - -## PARAMETERS - -### -Filter - -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Identity of the Teams Workload Policy. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Microsoft internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy +schema: 2.0.0 +title: Get-CsTeamsWorkLoadPolicy +--- + +# Get-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsWorkLoadPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsTeamsWorkLoadPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsWorkLoadPolicy +``` + +Retrieves the Teams Workload Policy instances and shows assigned values. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLocationDetectionPolicy.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLocationDetectionPolicy.md index 2dd5152b3d..eb6d0d3c3e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur Module Name: MicrosoftTeams +ms.author: arkozlov online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy -title: Get-CsTeamsWorkLocationDetectionPolicy schema: 2.0.0 -ms.author: arkozlov -manager: prashibadkur -author: artemiykozlov +title: Get-CsTeamsWorkLocationDetectionPolicy --- # Get-CsTeamsWorkLocationDetectionPolicy diff --git a/teams/teams-ps/teams/Get-CsTenant.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenant.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTenant.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenant.md index 2558268bcf..a502dadb37 100644 --- a/teams/teams-ps/teams/Get-CsTenant.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenant applicable: Microsoft Teams -title: Get-CsTenant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenant +schema: 2.0.0 +title: Get-CsTenant --- # Get-CsTenant @@ -93,7 +95,7 @@ In the Teams PowerShell Module version 3.0.0 or later, the following attributes ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenant ``` diff --git a/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers.md index 8f125d7c02..4175a2c16f 100644 --- a/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantBlockedCallingNumbers.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers -title: Get-CsTenantBlockedCallingNumbers applicable: Microsoft Teams -schema: 2.0.0 author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers +schema: 2.0.0 +title: Get-CsTenantBlockedCallingNumbers --- # Get-CsTenantBlockedCallingNumbers @@ -43,7 +45,7 @@ The scope of tenant blocked calling numbers is global across the given tenant. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantBlockedCallingNumbers ``` @@ -52,31 +54,31 @@ This example returns the tenant global settings for blocked calling numbers. It ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the scope, and for per-user scope a name, which identifies the TenantBlockedCallingNumbers to retrieve. +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to limit the number of results based on filters you specify. +### -Identity +The Identity parameter is a unique identifier that designates the scope, and for per-user scope a name, which identifies the TenantBlockedCallingNumbers to retrieve. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantDialPlan.md similarity index 93% rename from teams/teams-ps/teams/Get-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantDialPlan.md index 6981f68fc3..cc642cea83 100644 --- a/teams/teams-ps/teams/Get-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan applicable: Microsoft Teams -title: Get-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan +schema: 2.0.0 +title: Get-CsTenantDialPlan --- # Get-CsTenantDialPlan @@ -37,14 +38,14 @@ You can use the Get-CsTenantDialPlan cmdlet to retrieve specific information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantDialPlan ``` This example retrieves all existing tenant dial plans. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTenantDialPlan -Identity Vt1TenantDialPlan2 ``` @@ -54,13 +55,15 @@ This example retrieves the tenant dial plan that has an identity of Vt1TenantDia ## PARAMETERS ### -Filter + +> Applicable: Microsoft Teams + The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml Type: String Parameter Sets: (Filter) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter is a unique identifier that designates the name of the tenant dial plan to retrieve. ```yaml Type: String Parameter Sets: (Identity) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 diff --git a/teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantFederationConfiguration.md similarity index 97% rename from teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantFederationConfiguration.md index 8a7b9f790c..a3b0fea4a8 100644 --- a/teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantFederationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantfederationconfiguration applicable: Microsoft Teams -title: Get-CsTenantFederationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantfederationconfiguration +schema: 2.0.0 +title: Get-CsTenantFederationConfiguration --- # Get-CsTenantFederationConfiguration @@ -44,14 +46,14 @@ However, administrators must use the Get-CsTenantPublicProvider cmdlet in order ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantFederationConfiguration ``` The command shown in Exercise 1 returns federation configuration information for the current tenant: -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTenantFederationConfiguration | Select-Object -ExpandProperty AllowedDomains ``` diff --git a/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantLicensingConfiguration.md similarity index 97% rename from teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantLicensingConfiguration.md index 5eab013035..6f64ffae23 100644 --- a/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantLicensingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantlicensingconfiguration applicable: Microsoft Teams -title: Get-CsTenantLicensingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantlicensingconfiguration +schema: 2.0.0 +title: Get-CsTenantLicensingConfiguration --- # Get-CsTenantLicensingConfiguration @@ -40,7 +42,7 @@ If not, then licensing information is not available in the admin center. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantLicensingConfiguration ``` diff --git a/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantMigrationConfiguration.md similarity index 97% rename from teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantMigrationConfiguration.md index 23ce62dd9e..2ab0d4bbff 100644 --- a/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantMigrationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration applicable: Microsoft Teams -title: Get-CsTenantMigrationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration +schema: 2.0.0 +title: Get-CsTenantMigrationConfiguration --- # Get-CsTenantMigrationConfiguration @@ -29,7 +31,7 @@ The Get-CsTenantMigrationConfiguration cmdlet retrieves the Meeting Migration Se ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Get-CsTenantMigrationConfiguration ``` diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkConfiguration.md index 110a8e54cc..0727e1b885 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkConfiguration.md @@ -1,10 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkconfiguration -applicable: Microsoft Teams -title: Get-CsTenantNetworkConfiguration schema: 2.0.0 -ms.reviewer: +title: Get-CsTenantNetworkConfiguration --- # Get-CsTenantNetworkConfiguration diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkRegion.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkRegion.md index 4e5bac9aa2..881a83f9ea 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion applicable: Microsoft Teams -title: Get-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion +schema: 2.0.0 +title: Get-CsTenantNetworkRegion --- # Get-CsTenantNetworkRegion diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSite.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSite.md index 140fb2c326..e3c5bcdcbd 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite applicable: Microsoft Teams -title: Get-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite +schema: 2.0.0 +title: Get-CsTenantNetworkSite --- # Get-CsTenantNetworkSite diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSubnet.md similarity index 98% rename from teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSubnet.md index 451655976b..1f9d3788ad 100644 --- a/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet applicable: Microsoft Teams -title: Get-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet +schema: 2.0.0 +title: Get-CsTenantNetworkSubnet --- # Get-CsTenantNetworkSubnet @@ -54,31 +55,31 @@ The command shown in Example 2 returns the IPv6 format network subnet within the ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network subnets to be returned. +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Filter Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to limit the number of results based on filters you specify. +### -Identity +The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network subnets to be returned. ```yaml Type: String -Parameter Sets: Filter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md b/teams/teams-ps/MicrosoftTeams/Get-CsTenantTrustedIPAddress.md similarity index 99% rename from teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md rename to teams/teams-ps/MicrosoftTeams/Get-CsTenantTrustedIPAddress.md index 178e4bd1fa..b0e50fc1b2 100644 --- a/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsTenantTrustedIPAddress.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-cstenanttrustedipaddress applicable: Microsoft Teams -title: Get-CsTenantTrustedIPAddress -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenanttrustedipaddress +schema: 2.0.0 +title: Get-CsTenantTrustedIPAddress --- # Get-CsTenantTrustedIPAddress diff --git a/teams/teams-ps/teams/Get-CsUserCallingSettings.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserCallingSettings.md similarity index 96% rename from teams/teams-ps/teams/Get-CsUserCallingSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserCallingSettings.md index 43b422011c..7da20e9c1a 100644 --- a/teams/teams-ps/teams/Get-CsUserCallingSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserCallingSettings.md @@ -1,249 +1,248 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings -applicable: Microsoft Teams -title: Get-CsUserCallingSettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Get-CsUserCallingSettings - -## SYNOPSIS -This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. - -## SYNTAX - -```powershell -Get-CsUserCallingSettings -Identity [] - -``` - -## DESCRIPTION -This cmdlet shows the call forwarding, simultaneous ringing, call group and delegation settings for a user. It will also show any call groups the user is a member of and -if someone else has added the user as a delegate. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsUserCallingSettings -Identity user1@contoso.com -``` -```output -SipUri : sip:user1@contoso.com -IsForwardingEnabled : True -ForwardingType : Immediate -ForwardingTarget : -ForwardingTargetType : Voicemail -IsUnansweredEnabled : False -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : -``` - -This example shows that user1@contoso.com has immediate call forwarding set (IsForwardingEnabled and ForwardingType) to route all incoming calls to voicemail (ForwardingTargetType). - -### Example 2 -```powershell -Get-CsUserCallingSettings -Identity user2@contoso.com -``` -```output -SipUri : sip:user2@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : sip:user3@contoso.com -ForwardingTargetType : SingleTarget -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : -``` - -This example shows that user2@contoso.com has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to user3@contoso.com -(ForwardingTarget and ForwardingTargetType) and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed -to voicemail (UnansweredTargetType). - -### Example 3 -```powershell -Get-CsUserCallingSettings -Identity user4@contoso.com -``` -```output -SipUri : sip:user4@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : -ForwardingTargetType : Group -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {sip:user5@contoso.com} -GroupMembershipDetails : CallGroupOwnerId:sip:user6@contoso.com -GroupNotificationOverride : Mute -``` -```powershell -(Get-CsUserCallingSettings -Identity user4@contoso.com).GroupMembershipDetails -``` -```output -CallGroupOwnerId NotificationSetting ----------------- ------------------- -sip:user6@contoso.com Ring -``` - -This example shows that user4@contoso.com has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains user5@contoso.com -(CallGroupTargets). The call group is defined to ring members in the order listed in the call group (CallGroupOrder). - -You can also see that user4@contoso.com is a member of user6@contoso.com's call group (GroupMembershipDetails), that user6@contoso.com defined the call group with Ring -notification for user4@contoso.com (NotificationSetting) and that user4@contoso.com has decided to turn off call notification for call group calls (GroupNotificationOverride). - -### Example 4 -```powershell -Get-CsUserCallingSettings -Identity user7@contoso.com -``` -```output -SipUri : sip:opr7@contoso.com -IsForwardingEnabled : True -ForwardingType : Simultaneous -ForwardingTarget : -ForwardingTargetType : MyDelegates -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : Id:sip:user8@contoso.com -Delegators : -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : Ring -``` -```powershell -(Get-CsUserCallingSettings -Identity user7@contoso.com).Delegates -``` -```output -Id : sip:user8@contoso.com -MakeCalls : True -ManageSettings : True -ReceiveCalls : True -``` - -This example shows that user7@contoso.com has simultaneous ringing set to his/her delegates (ForwardingTargetType). User8@contoso.com is the only delegate -(Delegates) and that user has all the permissions you can have as a delegate (Delegates). - -### Example 5 -```powershell -Get-CsUserCallingSettings -Identity user9@contoso.com -``` -```output -SipUri : sip:user9@contoso.com -IsForwardingEnabled : False -ForwardingType : Immediate -ForwardingTarget : -ForwardingTargetType : Voicemail -IsUnansweredEnabled : True -UnansweredTarget : -UnansweredTargetType : Voicemail -UnansweredDelay : 00:00:20 -Delegates : -Delegators : Id:sip:user10@contoso.com -CallGroupOrder : InOrder -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : Ring -``` -```powershell -(Get-CsUserCallingSettings -Identity user9@contoso.com).Delegators -``` -```output -Id : sip:user10@contoso.com -MakeCalls : True -ManageSettings : True -ReceiveCalls : True -``` - -This example shows that user9@contoso.com is a delegate of user10@contoso.com (Delegators) and that user10@contoso.com has given user9@contoso.com all the -permissions you can have as a delegate (Delegators). - -### Example 6 -```powershell -Get-CsUserCallingSettings -Identity user11@contoso.com -``` -```output -SipUri : sip:user11@contoso.com -IsForwardingEnabled : -ForwardingType : -ForwardingTarget : -ForwardingTargetType : -IsUnansweredEnabled : -UnansweredTarget : -UnansweredTargetType : -UnansweredDelay : 00:00:20 -Delegates : -Delegators : -CallGroupOrder : Simultaneous -CallGroupTargets : {} -GroupMembershipDetails : -GroupNotificationOverride : -``` - -This example shows the default settings for a user that has never changed the call forward settings via Microsoft Teams. Note that for users with settings as shown here, -unanswered calls will by default be forwarded to voicemail after 30 seconds. - -## PARAMETERS - -### -Identity -The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -## RELATED LINKS - -[Set-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings +schema: 2.0.0 +title: Get-CsUserCallingSettings +--- + +# Get-CsUserCallingSettings + +## SYNOPSIS +This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. + +## SYNTAX + +```powershell +Get-CsUserCallingSettings -Identity [] + +``` + +## DESCRIPTION +This cmdlet shows the call forwarding, simultaneous ringing, call group and delegation settings for a user. It will also show any call groups the user is a member of and +if someone else has added the user as a delegate. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsUserCallingSettings -Identity user1@contoso.com +``` +```output +SipUri : sip:user1@contoso.com +IsForwardingEnabled : True +ForwardingType : Immediate +ForwardingTarget : +ForwardingTargetType : Voicemail +IsUnansweredEnabled : False +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : +``` + +This example shows that user1@contoso.com has immediate call forwarding set (IsForwardingEnabled and ForwardingType) to route all incoming calls to voicemail (ForwardingTargetType). + +### Example 2 +```powershell +Get-CsUserCallingSettings -Identity user2@contoso.com +``` +```output +SipUri : sip:user2@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : sip:user3@contoso.com +ForwardingTargetType : SingleTarget +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : +``` + +This example shows that user2@contoso.com has simultaneous ringing set (IsForwardingEnabled and ForwardingType) to user3@contoso.com +(ForwardingTarget and ForwardingTargetType) and if the call has not been answered (IsUnansweredEnabled) within 20 seconds (UnansweredDelay) the call is routed +to voicemail (UnansweredTargetType). + +### Example 3 +```powershell +Get-CsUserCallingSettings -Identity user4@contoso.com +``` +```output +SipUri : sip:user4@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : +ForwardingTargetType : Group +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {sip:user5@contoso.com} +GroupMembershipDetails : CallGroupOwnerId:sip:user6@contoso.com +GroupNotificationOverride : Mute +``` +```powershell +(Get-CsUserCallingSettings -Identity user4@contoso.com).GroupMembershipDetails +``` +```output +CallGroupOwnerId NotificationSetting +---------------- ------------------- +sip:user6@contoso.com Ring +``` + +This example shows that user4@contoso.com has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains user5@contoso.com +(CallGroupTargets). The call group is defined to ring members in the order listed in the call group (CallGroupOrder). + +You can also see that user4@contoso.com is a member of user6@contoso.com's call group (GroupMembershipDetails), that user6@contoso.com defined the call group with Ring +notification for user4@contoso.com (NotificationSetting) and that user4@contoso.com has decided to turn off call notification for call group calls (GroupNotificationOverride). + +### Example 4 +```powershell +Get-CsUserCallingSettings -Identity user7@contoso.com +``` +```output +SipUri : sip:opr7@contoso.com +IsForwardingEnabled : True +ForwardingType : Simultaneous +ForwardingTarget : +ForwardingTargetType : MyDelegates +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : Id:sip:user8@contoso.com +Delegators : +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : Ring +``` +```powershell +(Get-CsUserCallingSettings -Identity user7@contoso.com).Delegates +``` +```output +Id : sip:user8@contoso.com +MakeCalls : True +ManageSettings : True +ReceiveCalls : True +``` + +This example shows that user7@contoso.com has simultaneous ringing set to his/her delegates (ForwardingTargetType). User8@contoso.com is the only delegate +(Delegates) and that user has all the permissions you can have as a delegate (Delegates). + +### Example 5 +```powershell +Get-CsUserCallingSettings -Identity user9@contoso.com +``` +```output +SipUri : sip:user9@contoso.com +IsForwardingEnabled : False +ForwardingType : Immediate +ForwardingTarget : +ForwardingTargetType : Voicemail +IsUnansweredEnabled : True +UnansweredTarget : +UnansweredTargetType : Voicemail +UnansweredDelay : 00:00:20 +Delegates : +Delegators : Id:sip:user10@contoso.com +CallGroupOrder : InOrder +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : Ring +``` +```powershell +(Get-CsUserCallingSettings -Identity user9@contoso.com).Delegators +``` +```output +Id : sip:user10@contoso.com +MakeCalls : True +ManageSettings : True +ReceiveCalls : True +``` + +This example shows that user9@contoso.com is a delegate of user10@contoso.com (Delegators) and that user10@contoso.com has given user9@contoso.com all the +permissions you can have as a delegate (Delegators). + +### Example 6 +```powershell +Get-CsUserCallingSettings -Identity user11@contoso.com +``` +```output +SipUri : sip:user11@contoso.com +IsForwardingEnabled : +ForwardingType : +ForwardingTarget : +ForwardingTargetType : +IsUnansweredEnabled : +UnansweredTarget : +UnansweredTargetType : +UnansweredDelay : 00:00:20 +Delegates : +Delegators : +CallGroupOrder : Simultaneous +CallGroupTargets : {} +GroupMembershipDetails : +GroupNotificationOverride : +``` + +This example shows the default settings for a user that has never changed the call forward settings via Microsoft Teams. Note that for users with settings as shown here, +unanswered calls will by default be forwarded to voicemail after 30 seconds. + +## PARAMETERS + +### -Identity +The Identity of the user to show call forwarding, simultaneous ringing, call group and delegation settings for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +## RELATED LINKS + +[Set-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyAssignment.md similarity index 99% rename from teams/teams-ps/teams/Get-CsUserPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyAssignment.md index 692be05e33..9b36a59473 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyAssignment.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment -title: Get-CsUserPolicyAssignment -schema: 2.0.0 -author: tomkau ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment +schema: 2.0.0 +title: Get-CsUserPolicyAssignment --- # Get-CsUserPolicyAssignment @@ -88,44 +89,41 @@ d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/20 ## PARAMETERS -### -Identity -The identify of the user whose policy assignments will be returned. - -The -Identity parameter can be in the form of the users ObjectID (taken from Microsoft Entra ID) or in the form of the UPN (a.smith@example.com) +### -Break +Wait for .NET debugger to attach ```yaml -Type: String -Parameter Sets: Get +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: 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. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline ```yaml -Type: IIc3AdminConfigRpPolicyIdentity -Parameter Sets: GetViaIdentity +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -Use to filter to a specific policy type. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline ```yaml -Type: String +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -136,41 +134,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach +### -Identity +The identify of the user whose policy assignments will be returned. + +The -Identity parameter can be in the form of the users ObjectID (taken from Microsoft Entra ID) or in the form of the UPN (a.smith@example.com) ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: Get Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: IIc3AdminConfigRpPolicyIdentity +Parameter Sets: GetViaIdentity Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -PolicyType +Use to filter to a specific policy type. ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: diff --git a/teams/teams-ps/teams/Get-CsUserPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackage.md similarity index 97% rename from teams/teams-ps/teams/Get-CsUserPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackage.md index c0edaf3689..d08450912a 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Get-CsUserPolicyPackage -author: serdarsoysal ms.author: serdars -manager: amitar online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage schema: 2.0.0 +title: Get-CsUserPolicyPackage --- # Get-CsUserPolicyPackage @@ -39,13 +40,14 @@ Returns the policy package that's assigned to johndoe@example.com. ### -Identity +> Applicable: Microsoft Teams + The user that will get their assigned policy package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None diff --git a/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackageRecommendation.md similarity index 98% rename from teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md rename to teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackageRecommendation.md index ca19b2c0d9..98704b56c4 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsUserPolicyPackageRecommendation.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Get-CsUserPolicyPackageRecommendation -author: serdarsoysal ms.author: serdars -manager: amitar online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation schema: 2.0.0 +title: Get-CsUserPolicyPackageRecommendation --- # Get-CsUserPolicyPackageRecommendation @@ -39,13 +40,14 @@ Returns recommendations for which policy packages are best suited for johndoe@ex ### -Identity +> Applicable: Microsoft Teams + The user that will receive policy package recommendations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None diff --git a/teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/Get-CsVideoInteropServiceProvider.md similarity index 91% rename from teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/Get-CsVideoInteropServiceProvider.md index 2210e9d40f..e3e9fcbc91 100644 --- a/teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/Get-CsVideoInteropServiceProvider.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csvideointeropserviceprovider applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Get-CsVideoInteropServiceProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/get-csvideointeropserviceprovider +schema: 2.0.0 +title: Get-CsVideoInteropServiceProvider --- # Get-CsVideoInteropServiceProvider ## SYNOPSIS -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. +Get information about the Cloud Video Interop for Teams. ## SYNTAX diff --git a/teams/teams-ps/teams/Get-M365TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Get-M365TeamsApp.md similarity index 99% rename from teams/teams-ps/teams/Get-M365TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Get-M365TeamsApp.md index 2d665c2c79..7d0c8e15fb 100644 --- a/teams/teams-ps/teams/Get-M365TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Get-M365TeamsApp.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Get-M365TeamsApp applicable: Microsoft Teams -title: Get-M365TeamsApp author: lkueter -ms.author: sribagchi +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi +online version: https://docs.microsoft.com/powershell/module/teams/Get-M365TeamsApp schema: 2.0.0 +title: Get-M365TeamsApp --- # Get-M365TeamsApp diff --git a/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedCustomPendingApps.md similarity index 59% rename from teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md rename to teams/teams-ps/MicrosoftTeams/Get-M365UnifiedCustomPendingApps.md index 0e4deaa2f7..9c0e245dc3 100644 --- a/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md +++ b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedCustomPendingApps.md @@ -1,17 +1,18 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Get-M365UnifiedCustomPendingApps applicable: Microsoft Teams -title: Get-M365UnifiedCustomPendingApps author: michelle-paradis -ms.author: mparadis +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: swmerchant +Module Name: MicrosoftTeams +ms.author: mparadis ms.date: 01/14/2025 +online version: https://docs.microsoft.com/powershell/module/teams/Get-M365UnifiedCustomPendingApps schema: 2.0.0 +title: Get-M365UnifiedCustomPendingApps --- -# Get-M365UnifiedCustomPendingApps +# Get-M365UnifiedCustomPendingApps ## SYNOPSIS @@ -19,7 +20,7 @@ This cmdlet returns all custom Microsoft Teams apps that are pending review from ## SYNTAX -```powershell +``` Get-M365UnifiedCustomPendingApps [] ``` @@ -29,7 +30,7 @@ Get-M365UnifiedCustomPendingApps retrieves a complete list of all custom Microso ## EXAMPLES -### Example +### Example 1 ```powershell PS C:\> Get-M365UnifiedCustomPendingApps @@ -51,27 +52,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object -**Id**: -Application ID of the Teams app. - -**ExternalId**: -External ID of the Teams app. - -**Iteration**: -The Staged App Definition Etag of the app. This is a unique tag created everytime the staged app is updated, to help track changes. - -**CreatedBy**: -The User ID of the user that created the app. - -**LastUpdateDateTime**: -The date and time the app was last updated. - -**ReviewStatus**: -The review status of the app. -Values: +- **Id**: Application ID of the Teams app. +- **ExternalId**: External ID of the Teams app. +- **Iteration**: The Staged App Definition Etag of the app. This is a unique tag created every time + the staged app is updated, to help track changes. +- **CreatedBy**: The User ID of the user that created the app. +- **LastUpdateDateTime**: The date and time the app was last updated. +- **ReviewStatus**: The review status of the app. Values: + - PendingPublishing: A new custom app was requested that hasn't been published before. + - PendingUpdate: An existing custom app that was previously published and now has an update. +- **Metadata**: The metadata of the app. -- PendingPublishing: A new custom app was requested that hasn't been published before. -- PendingUpdate: An existing custom app that was previously published and now has an update. +## NOTES -**Metadata**: -The metadata of the app. +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedTenantSettings.md similarity index 99% rename from teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Get-M365UnifiedTenantSettings.md index c67594e6ff..df2861001b 100644 --- a/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Get-M365UnifiedTenantSettings.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Get-M365UnifiedTenantSettings applicable: Microsoft Teams -title: Get-M365UnifiedTenantSettings author: lkueter -ms.author: sribagchi +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 10/22/2024 +online version: https://docs.microsoft.com/powershell/module/teams/Get-M365UnifiedTenantSettings schema: 2.0.0 +title: Get-M365UnifiedTenantSettings --- # Get-M365UnifiedTenantSettings diff --git a/teams/teams-ps/teams/Get-SharedWithTeam.md b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeam.md similarity index 97% rename from teams/teams-ps/teams/Get-SharedWithTeam.md rename to teams/teams-ps/MicrosoftTeams/Get-SharedWithTeam.md index 4728ffa1b4..0998549a9e 100644 --- a/teams/teams-ps/teams/Get-SharedWithTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeam.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteam -title: Get-SharedWithTeam -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteam +schema: 2.0.0 +title: Get-SharedWithTeam --- # Get-SharedWithTeam @@ -41,8 +42,8 @@ Returns detail of a team with which a specified channel is shared. ## PARAMETERS -### -HostTeamId -Team ID of the host team (Group ID). +### -ChannelId +Thread ID of the shared channel. ```yaml Type: String @@ -56,8 +57,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ChannelId -Thread ID of the shared channel. +### -HostTeamId +Team ID of the host team (Group ID). ```yaml Type: String @@ -91,7 +92,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### HostTeamId, ChannelId, SharedWithTeamId +### HostTeamId + +### ChannelId + +### SharedWithTeamId ## OUTPUTS diff --git a/teams/teams-ps/teams/Get-SharedWithTeamUser.md b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeamUser.md similarity index 97% rename from teams/teams-ps/teams/Get-SharedWithTeamUser.md rename to teams/teams-ps/MicrosoftTeams/Get-SharedWithTeamUser.md index 4a3f016867..e45c0ef7bd 100644 --- a/teams/teams-ps/teams/Get-SharedWithTeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-SharedWithTeamUser.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteamuser -title: Get-SharedWithTeamUser -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteamuser +schema: 2.0.0 +title: Get-SharedWithTeamUser --- # Get-SharedWithTeamUser @@ -42,8 +43,8 @@ Returns owners of a team with which a specified channel is shared. ## PARAMETERS -### -HostTeamId -Team ID of the host team (Group ID). +### -ChannelId +Thread ID of the shared channel. ```yaml Type: String @@ -57,8 +58,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ChannelId -Thread ID of the shared channel. +### -HostTeamId +Team ID of the host team (Group ID). ```yaml Type: String @@ -72,33 +73,33 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -SharedWithTeamId -Team ID of the shared with team. +### -Role +Filters the results to only users with the given role of "Owner" or "Member". ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True Accept wildcard characters: False ``` -### -Role -Filters the results to only users with the given role of "Owner" or "Member". +### -SharedWithTeamId +Team ID of the shared with team. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -107,7 +108,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### HostTeamId, ChannelId, SharedWithTeamId +### HostTeamId + +### ChannelId + +### SharedWithTeamId ## OUTPUTS diff --git a/teams/teams-ps/teams/Get-Team.md b/teams/teams-ps/MicrosoftTeams/Get-Team.md similarity index 79% rename from teams/teams-ps/teams/Get-Team.md rename to teams/teams-ps/MicrosoftTeams/Get-Team.md index b2edb13e51..cde61c93f7 100644 --- a/teams/teams-ps/teams/Get-Team.md +++ b/teams/teams-ps/MicrosoftTeams/Get-Team.md @@ -1,19 +1,18 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/get-team -title: Get-Team schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Get-Team --- # Get-Team ## SYNOPSIS - -This cmdlet supports retrieving teams with particular properties/information, including all teams that a specific user belongs to, all teams that have been archived, all teams with a specific display name, or all teams in the organization. +Get Team information based on particular properties. ## SYNTAX @@ -71,52 +70,12 @@ Returns the team that includes the specified escaped representation of its Displ ## PARAMETERS -### -User -User's UPN (user principal name - e.g. -johndoe@example.com) - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Filters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Archived If $true, filters to return teams that have been archived. If $false, filters to return teams that have not been archived. Do not specify any value to return teams that match filter regardless of archived state. This is a filter rather than an exact match. ```yaml Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Boolean -Parameter Sets: Filters +Parameter Sets: Identity, Filters Aliases: Required: False @@ -131,19 +90,7 @@ Specify this parameter to return teams with the provided display name as a filte ```yaml Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Filters +Parameter Sets: Identity, Filters Aliases: Required: False @@ -173,7 +120,7 @@ Specify the mailnickname of the team that is being returned. This acts as a filt ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Identity, Filters Aliases: Required: False @@ -183,24 +130,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NumberOfThreads +Specifies the number of threads to use. If you have sufficient network bandwidth and want to decrease the time required to retrieve the list of teams, use the -NumberOfThreads parameter, which supports a value from 1 through 20. + ```yaml -Type: String -Parameter Sets: Filters +Type: Int32 +Parameter Sets: All Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: False +Default value: 20 +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Visibility -Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. +### -User +User's UPN (user principal name - e.g. +johndoe@example.com) ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: Identity, Filters Aliases: Required: False @@ -210,9 +161,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Visibility +Filters to return teams with a set "visibility" value. Accepted values are "Public", "Private" or "HiddenMembership". Do not specify any value to return teams that match filter regardless of visibility. This is a filter rather than an exact match. + ```yaml Type: String -Parameter Sets: Filters +Parameter Sets: Identity, Filters Aliases: Required: False @@ -222,27 +176,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberOfThreads -Specifies the number of threads to use. If you have sufficient network bandwidth and want to decrease the time required to retrieve the list of teams, use the -NumberOfThreads parameter, which supports a value from 1 through 20. - -```yaml -Type: Int32 -Parameter Sets: All -Aliases: - -Required: False -Position: Named -Default value: 20 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### UPN, UserID +### UPN + +### UserID ## OUTPUTS diff --git a/teams/teams-ps/teams/Get-TeamAllChannel.md b/teams/teams-ps/MicrosoftTeams/Get-TeamAllChannel.md similarity index 97% rename from teams/teams-ps/teams/Get-TeamAllChannel.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamAllChannel.md index eae8aeb08e..96e84b5d54 100644 --- a/teams/teams-ps/teams/Get-TeamAllChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamAllChannel.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamallchannel -title: Get-TeamAllChannel -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/teams/get-teamallchannel +schema: 2.0.0 +title: Get-TeamAllChannel --- # Get-TeamAllChannel @@ -75,7 +76,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, MembershipType +### GroupId + +### MembershipType ## OUTPUTS diff --git a/teams/teams-ps/teams/Get-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/Get-TeamChannel.md similarity index 99% rename from teams/teams-ps/teams/Get-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamChannel.md index 9eae890d9e..aebf1fd564 100644 --- a/teams/teams-ps/teams/Get-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamChannel.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-teamchannel -title: Get-TeamChannel schema: 2.0.0 +title: Get-TeamChannel --- # Get-TeamChannel diff --git a/teams/teams-ps/teams/Get-TeamChannelUser.md b/teams/teams-ps/MicrosoftTeams/Get-TeamChannelUser.md similarity index 99% rename from teams/teams-ps/teams/Get-TeamChannelUser.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamChannelUser.md index a245c41c40..6238822cdf 100644 --- a/teams/teams-ps/teams/Get-TeamChannelUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamChannelUser.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-teamchanneluser -title: Get-TeamChannelUser schema: 2.0.0 +title: Get-TeamChannelUser --- # Get-TeamChannelUser @@ -32,8 +33,8 @@ Get owners of channel with display name as "Engineering" ## PARAMETERS -### -GroupId -GroupId of the team +### -DisplayName +Display name of the channel ```yaml Type: String @@ -47,8 +48,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Display name of the channel +### -GroupId +GroupId of the team ```yaml Type: String diff --git a/teams/teams-ps/teams/Get-TeamIncomingChannel.md b/teams/teams-ps/MicrosoftTeams/Get-TeamIncomingChannel.md similarity index 99% rename from teams/teams-ps/teams/Get-TeamIncomingChannel.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamIncomingChannel.md index b1ad0429ef..bf5d94551a 100644 --- a/teams/teams-ps/teams/Get-TeamIncomingChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamIncomingChannel.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamincomingchannel -title: Get-TeamIncomingChannel -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/teams/get-teamincomingchannel +schema: 2.0.0 +title: Get-TeamIncomingChannel --- # Get-TeamIncomingChannel diff --git a/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md b/teams/teams-ps/MicrosoftTeams/Get-TeamTargetingHierarchyStatus.md similarity index 93% rename from teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamTargetingHierarchyStatus.md index 2480953c1b..bc30d6993f 100644 --- a/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamTargetingHierarchyStatus.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus -title: Get-TeamTargetingHierarchyStatus schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Get-TeamTargetingHierarchyStatus --- # Get-TeamTargetingHierarchyStatus @@ -20,6 +20,8 @@ Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://l ``` Get-TeamTargetingHierarchyStatus [-RequestId ] [-ApiVersion ] [] ``` +## DESCRIPTION +The `Get-TeamTargetingHierarchyStatus` cmdlet retrieves the status of a hierarchy upload initiated by the `Set-TeamTargetingHierarchy` cmdlet. It provides information about the success or failure of the upload, including any errors encountered during the process. ## EXAMPLES @@ -67,35 +69,35 @@ Prompts for user credentials to connect and manage a Microsoft Teams environment ## PARAMETERS -### -RequestId -Specifies the ID returned by the Set-TeamTargetingHierarchy cmdlet. This parameter is optional and the status of the most recent upload will be retrieved. +### -ApiVersion +The version of the Hierarchy APIs to use. Valid values are: 1 or 2. + +Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None -Accept pipeline input: False +Default value: 1 +Accept pipeline input: false Accept wildcard characters: False ``` -### -ApiVersion -The version of the Hierarchy APIs to use. Valid values are: 1 or 2. - -Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. +### -RequestId +Specifies the ID returned by the Set-TeamTargetingHierarchy cmdlet. This parameter is optional and the status of the most recent upload will be retrieved. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 1 -Accept pipeline input: false +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Get-TeamUser.md b/teams/teams-ps/MicrosoftTeams/Get-TeamUser.md similarity index 99% rename from teams/teams-ps/teams/Get-TeamUser.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamUser.md index a7b4fd3d69..c9dd88f879 100644 --- a/teams/teams-ps/teams/Get-TeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamUser.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/get-teamuser -title: Get-TeamUser schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Get-TeamUser --- # Get-TeamUser diff --git a/teams/teams-ps/teams/Get-TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Get-TeamsApp.md similarity index 99% rename from teams/teams-ps/teams/Get-TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Get-TeamsApp.md index e393faf0f5..a36ecd0e89 100644 --- a/teams/teams-ps/teams/Get-TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Get-TeamsApp.md @@ -1,13 +1,14 @@ --- +author: joeyglocke external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: islubin Module Name: MicrosoftTeams -title: Get-TeamsApp -author: joeyglocke ms.author: joglocke ms.reviewer: ken.withee -manager: islubin online version: https://learn.microsoft.com/powershell/module/teams/get-teamsapp schema: 2.0.0 +title: Get-TeamsApp --- # Get-TeamsApp diff --git a/teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsApplicationAccessPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsApplicationAccessPolicy.md index b321e2118c..ea7193aee5 100644 --- a/teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy applicable: Microsoft Teams -title: Grant-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni author: frankpeng7 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy +schema: 2.0.0 +title: Grant-CsApplicationAccessPolicy --- # Grant-CsApplicationAccessPolicy @@ -76,30 +77,13 @@ The command shown above assigns the per-user application access policy "ASimpleP ## PARAMETERS -### -Identity - -Indicates the user (object) ID of the user account to be assigned the per-user application access policy. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:ASimplePolicy has a PolicyName equal to ASimplePolicy. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -139,12 +123,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Identity + +Indicates the user (object) ID of the user account to be assigned the per-user application access policy. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) Aliases: Required: False @@ -154,13 +155,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -PassThru + +Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. Be aware that this parameter is tied to the cmdlet itself instead of to a property of the input object. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -169,12 +171,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsftInternalProcessingMode +### -PolicyName -For internal use only. +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:ASimplePolicy has a PolicyName equal to ASimplePolicy. ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -185,13 +187,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru - -Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. Be aware that this parameter is tied to the cmdlet itself instead of to a property of the input object. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False diff --git a/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Grant-CsCallingLineIdentity.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsCallingLineIdentity.md index bac8b79e4c..6fac0e6c38 100644 --- a/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity applicable: Microsoft Teams -title: Grant-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity +schema: 2.0.0 +title: Grant-CsCallingLineIdentity --- # Grant-CsCallingLineIdentity @@ -60,13 +61,13 @@ This example assigns the Caller ID policy with the Identity CallerIDSeattle to t ## PARAMETERS -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter -Parameter Sets: (GrantToTenant) -Aliases: +Parameter Sets: (All) +Aliases: cf applicable: Microsoft Teams Required: False @@ -76,12 +77,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsCallingLineIdentity cmdlet does not pass objects through the pipeline. +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: (GrantToTenant) Aliases: applicable: Microsoft Teams @@ -92,44 +93,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name (Identity) of the Caller ID policy to be assigned. To remove an existing user level policy assignment, specify PolicyName as $null. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: applicable: Microsoft Teams -Required: False -Position: 1 +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -Identity +The Identity of the user to whom the policy is being assigned. User Identities can be specified using the user's SIP address, the user's user principal name (UPN), or +the user's ObjectId/Identity. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (Identity) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsCallingLineIdentity cmdlet does not pass objects through the pipeline. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -139,30 +141,30 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity of the user to whom the policy is being assigned. User Identities can be specified using the user's SIP address, the user's user principal name (UPN), or -the user's ObjectId/Identity. + +### -PolicyName +The name (Identity) of the Caller ID policy to be assigned. To remove an existing user level policy assignment, specify PolicyName as $null. ```yaml Type: String -Parameter Sets: (Identity) +Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: 0 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: applicable: Microsoft Teams Required: False @@ -171,14 +173,13 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -WhatIf +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi applicable: Microsoft Teams Required: False diff --git a/teams/teams-ps/teams/Grant-CsDialoutPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsDialoutPolicy.md similarity index 95% rename from teams/teams-ps/teams/Grant-CsDialoutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsDialoutPolicy.md index 73c1d5c787..52723cdb0c 100644 --- a/teams/teams-ps/teams/Grant-CsDialoutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsDialoutPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csdialoutpolicy applicable: Microsoft Teams -title: Grant-CsDialoutPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/grant-csdialoutpolicy +schema: 2.0.0 +title: Grant-CsDialoutPolicy --- # Grant-CsDialoutPolicy @@ -76,14 +77,34 @@ This example assigns the policy instance "DialoutCPCandPSTNInternational" to the ## PARAMETERS +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global + +> Applicable: Microsoft Teams + This parameter sets the tenant global policy instance. This is the policy that all users in the tenant will get unless they have a specific policy instance assigned. ```yaml Type: SwitchParameter Parameter Sets: GrantToTenant Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -93,13 +114,15 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: Microsoft Teams + Specifies the group used for the group policy assignment. ```yaml Type: String Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams Required: True Position: 0 @@ -109,13 +132,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of three formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's ObjectId/Identity. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 0 @@ -125,13 +150,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams + Returns the results of the command. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -141,6 +168,9 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Microsoft Teams + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DialoutCPCZoneAPSTNDomestic has a PolicyName equal to DialoutCPCZoneAPSTNDomestic. To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). @@ -149,7 +179,6 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -159,13 +188,15 @@ Accept wildcard characters: False ``` ### -Rank + +> Applicable: Microsoft Teams + The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml Type: Int32 Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -175,6 +206,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -182,23 +216,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsExternalAccessPolicy.md similarity index 88% rename from teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsExternalAccessPolicy.md index ffce2c43e2..66c3824375 100644 --- a/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsExternalAccessPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy applicable: Microsoft Teams -title: Grant-CsExternalAccessPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy +schema: 2.0.0 +title: Grant-CsExternalAccessPolicy --- # Grant-CsExternalAccessPolicy @@ -15,9 +17,6 @@ ms.reviewer: rogupta ## SYNOPSIS Enables you to assign an external access policy to a user or a group of users. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. - -This cmdlet was introduced in Lync Server 2010. ## SYNTAX @@ -42,6 +41,7 @@ Grant-CsExternalAccessPolicy [[-PolicyName] ] [-Global] [-Force] [ Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified, then the Grant-CsExternalAccessPolicy cmdlet will contact the first available domain controller. ```yaml -Type: UserIdParameter -Parameter Sets: GrantToUser +Type: Fqdn +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondAccessPolicy has a PolicyName equal to RedmondAccessPolicy. +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". -To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 2 +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. -If this parameter is not specified, then the Grant-CsExternalAccessPolicy cmdlet will contact the first available domain controller. +### -Identity + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Identity of the user account the policy should be assigned to. +User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. + +In addition, you can use the asterisk (*) wildcard character when specifying the user Identity. +For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith." ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: UserIdParameter +Parameter Sets: GrantToUser Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsExternalAccessPolicy cmdlet does not pass objects through the pipeline. @@ -196,7 +213,6 @@ By default, the Grant-CsExternalAccessPolicy cmdlet does not pass objects throug Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -205,17 +221,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -PolicyName + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondAccessPolicy has a PolicyName equal to RedmondAccessPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -236,31 +258,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". +### -Tenant +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: Guid +Parameter Sets: (All) Aliases: +applicable: Microsoft Teams -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md b/teams/teams-ps/MicrosoftTeams/Grant-CsGroupPolicyPackageAssignment.md similarity index 98% rename from teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsGroupPolicyPackageAssignment.md index a3f18f52c8..8195bb1cf0 100644 --- a/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsGroupPolicyPackageAssignment.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: Grant-CsGroupPolicyPackageAssignment -author: serdarsoysal ms.author: serdars -manager: dasosby online version: https://learn.microsoft.com/powershell/module/teams/grant-csgrouppolicypackageassignment schema: 2.0.0 +title: Grant-CsGroupPolicyPackageAssignment --- # Grant-CsGroupPolicyPackageAssignment @@ -50,15 +51,31 @@ Assigns the Education_Teacher policy package to the group. The group will receiv ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GroupId +> Applicable: Microsoft Teams + A group id in the tenant. It can either be a group's object id or a group's email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -68,13 +85,14 @@ Accept wildcard characters: False ### -PackageName +> Applicable: Microsoft Teams + The name of a policy package. All policy package names can be found by running Get-CsPolicyPackage. To reset the currently assigned package value for the group, use $null or an empty string "". This will not remove any existing policy assignments to the group. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -84,13 +102,14 @@ Accept wildcard characters: False ### -PolicyRankings +> Applicable: Microsoft Teams + The policy rankings for each of the policy types in the package. To specify the policy rankings, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). Policy rank must be a number greater than or equal to 1. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 2 Default value: None @@ -114,21 +133,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineAudioConferencingRoutingPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsOnlineAudioConferencingRoutingPolicy.md index d9f1d28be6..af0c862c9c 100644 --- a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,247 +1,248 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy -title: Grant-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# Grant-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. - -To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." - -The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. - -Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com -``` - -Applies the policy "test" to the user "". - -### Example 2 - -```powershell -PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity Global -``` - -Applies the policy "test" to the entire tenant. - -### Example 3 - -```powershell -PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test -``` - -Applies the policy "test" to the specified group. - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -This can be used to apply the policy to the entire tenant. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group - -This is the identifier of the group that the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the identity of the target user. - -Example: - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -Use the "Global" Identity if you wish to set the policy for the entire tenant. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank - -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) -[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) -[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) -[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Grant-CsOnlineAudioConferencingRoutingPolicy +--- + +# Grant-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Applies the policy "test" to the user "". + +### Example 2 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity Global +``` + +Applies the policy "test" to the entire tenant. + +### Example 3 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Applies the policy "test" to the specified group. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +This can be used to apply the policy to the entire tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the target user. + +Example: + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy.md index 4f5598bbb8..56ee96bd92 100644 --- a/teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Grant-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Grant-CsOnlineVoiceRoutingPolicy --- # Grant-CsOnlineVoiceRoutingPolicy @@ -76,59 +77,57 @@ Example 5 assigns the online voice routing policy RedmondOnlineVoiceRoutingPolic ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user online voice routing policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. ```yaml -Type: String -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the online voice routing policy. By default, the `Grant-CsOnlineVoiceRoutingPolicy` cmdlet does not pass objects through the pipeline. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: GrantToGroup Aliases: -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondOnlineVoiceRoutingPolicy has a PolicyName equal to RedmondOnlineVoiceRoutingPolicy. - -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +### -Identity +Indicates the Identity of the user account to be assigned the per-user online voice routing policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity Aliases: -Required: True -Position: 1 +Required: False +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the online voice routing policy. By default, the `Grant-CsOnlineVoiceRoutingPolicy` cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant +Parameter Sets: (All) Aliases: Required: False @@ -138,16 +137,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondOnlineVoiceRoutingPolicy has a PolicyName equal to RedmondOnlineVoiceRoutingPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: Required: True -Position: 0 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy.md index fada417049..b265781a3b 100644 --- a/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsOnlineVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy applicable: Microsoft Teams -title: Grant-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy +schema: 2.0.0 +title: Grant-CsOnlineVoicemailPolicy --- # Grant-CsOnlineVoicemailPolicy @@ -52,13 +53,13 @@ The command shown in Example 2 assigns the online voicemail policy Transcription ## PARAMETERS -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. +### -Confirm +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False @@ -68,11 +69,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsOnlineVoicemailPolicy cmdlet does not pass objects through the pipeline. +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -84,44 +85,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -A unique identifier(name) of the policy. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: applicable: Microsoft Teams -Required: False -Position: 1 +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -Identity +The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP address or an Object ID. ```yaml -Type: String -Parameter Sets: GrantToGroup +Type: System.String +Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsOnlineVoicemailPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -132,29 +133,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP address or an Object ID. +### -PolicyName +A unique identifier(name) of the policy. ```yaml -Type: System.String +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: applicable: Microsoft Teams Required: False @@ -164,13 +165,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi applicable: Microsoft Teams Required: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAIPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAIPolicy.md index 4b3575f42c..c50afa2352 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: Andy447 external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Grant-CsTeamsAIPolicy +ms.author: andywang online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsAIPolicy schema: 2.0.0 -author: Andy447 -ms.author: andywang +title: Grant-CsTeamsAIPolicy --- # Grant-CsTeamsAIPolicy @@ -190,4 +191,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) -[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) \ No newline at end of file +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppPermissionPolicy.md similarity index 86% rename from teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppPermissionPolicy.md index 76d9afbba6..7de138b4b6 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppPermissionPolicy.md @@ -1,23 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsapppermissionpolicy applicable: Microsoft Teams -title: Grant-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: mhayrapetyan +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsapppermissionpolicy +schema: 2.0.0 +title: Grant-CsTeamsAppPermissionPolicy --- # Grant-CsTeamsAppPermissionPolicy ## SYNOPSIS -**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. - -As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . - -This is only applicable for tenants who have not been migrated to ACM or UAM. +As an admin, you can use app permission policies to allow or block apps for your users. ## SYNTAX @@ -47,6 +45,8 @@ Grant-CsTeamsAppPermissionPolicy [[-PolicyName] ] [-Global] [-Force] [. +This is only applicable for tenants who have not been migrated to ACM or UAM. + ## EXAMPLES ### Example 1 @@ -102,6 +102,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The user to whom the policy should be assigned. @@ -146,6 +161,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named + +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant Do not use. @@ -177,37 +208,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named - -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy.md similarity index 85% rename from teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy.md index 3568887beb..cef8534e3e 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAppSetupPolicy.md @@ -1,24 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsappsetuppolicy applicable: Microsoft Teams -title: Grant-CsTeamsAppSetupPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsappsetuppolicy +schema: 2.0.0 +title: Grant-CsTeamsAppSetupPolicy --- # Grant-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. ## SYNTAX @@ -105,6 +102,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The user to whom the policy should be assigned. @@ -149,6 +161,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant Do not use. @@ -180,36 +207,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy.md index 10b0d7085d..d1b1dd3483 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy -title: Grant-CsTeamsAudioConferencingPolicy schema: 2.0.0 +title: Grant-CsTeamsAudioConferencingPolicy --- # Grant-CsTeamsAudioConferencingPolicy @@ -47,6 +48,21 @@ In this example, a user with identity "Ken Myer" is being assigned the "Emea Use ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. @@ -62,6 +78,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the Identity of the user account to be assigned the per-user online voice routing policy. User Identities can be specified using one of the following formats: 1) the user's SIP address; 2) the user's user principal name (UPN); or, 3) the user's Active Directory display name (for example, Ken Myer). @@ -123,36 +154,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy.md index 6d1b8028b7..d42112a4ef 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy applicable: Microsoft Teams -title: Grant-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy +schema: 2.0.0 +title: Grant-CsTeamsCallHoldPolicy --- # Grant-CsTeamsCallHoldPolicy @@ -79,6 +80,51 @@ The command shown in Example 5 sets the Teams call hold policy, ContosoPartnerTe ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the Identity of the user account to be assigned the per-user Teams call hold policy. User Identities can be specified using one of the following formats: @@ -135,36 +181,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Rank The rank of the policy assignment, relative to other group policy assignments for the same policy type. @@ -196,21 +212,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallParkPolicy.md similarity index 83% rename from teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallParkPolicy.md index 65c8d7ab00..e873cc3d61 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallParkPolicy.md @@ -1,22 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallparkpolicy applicable: Microsoft Teams -title: Grant-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallparkpolicy +schema: 2.0.0 +title: Grant-CsTeamsCallParkPolicy --- # Grant-CsTeamsCallParkPolicy ## SYNOPSIS - -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. - -NOTE: the call park feature currently only available in desktop, web clients and mobile clients. Call Park functionality is currently on the roadmap for Teams IP Phones. Supported with TeamsOnly mode for users with the Phone System license +The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. ## SYNTAX @@ -36,7 +34,14 @@ Grant-CsTeamsCallParkPolicy [-Group] [[-PolicyName] ] [-PassThr ``` ## DESCRIPTION -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different phone. The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. +The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in +Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then +perform a number of actions on that call: transfer to another department, retrieve via the same +phone, or retrieve via a different phone. + +NOTE: the call park feature currently only available in desktop, web clients and mobile clients. +Call Park functionality is currently on the roadmap for Teams IP Phones. Supported with TeamsOnly +mode for users with the Phone System license ## EXAMPLES @@ -56,27 +61,27 @@ Assigns a custom policy "Sales Policy" to the members of the group sales@contoso ## PARAMETERS -### -Identity -The User ID of the user to whom the policy is being assigned. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. By default, the cmdlet does not pass objects through the pipeline. +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: Required: False @@ -86,29 +91,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope ("tag:"). For example, a policy that has the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. - -If you set PolicyName to a null value, the command will unassign any per-user policy assigned to the user. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. +### -Identity +The User ID of the user to whom the policy is being assigned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. By default, the cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant +Parameter Sets: (All) Aliases: Required: False @@ -118,16 +136,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope ("tag:"). For example, a policy that has the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. + +If you set PolicyName to a null value, the command will unassign any per-user policy assigned to the user. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: Required: True -Position: 0 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -164,21 +184,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallingPolicy.md index c843a89e58..f418146243 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCallingPolicy.md @@ -1,14 +1,14 @@ --- +applicable: Microsoft Teams +author: serdarsoysal external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy -applicable: Microsoft Teams -title: Grant-CsTeamsCallingPolicy schema: 2.0.0 -manager: bulenteg -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Grant-CsTeamsCallingPolicy --- # Grant-CsTeamsCallingPolicy @@ -63,57 +63,57 @@ Assigns the TeamsCallingPolicy called "SalesCallingPolicy" to the members of the ## PARAMETERS -### -Identity -The user object to whom the policy is being assigned. +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml -Type: String -Parameter Sets: (Identity) +Type: SwitchParameter +Parameter Sets: (GrantToTenant) Aliases: Required: False -Position: 0 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsCallingPolicy cmdlet does not pass objects through the pipeline. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: (GrantToGroup) Aliases: -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the policy being assigned. To remove an existing user level policy assignment, specify PolicyName as $null. +### -Identity +The user object to whom the policy is being assigned. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (Identity) Aliases: Required: False -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsCallingPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter -Parameter Sets: (GrantToTenant) +Parameter Sets: (All) Aliases: Required: False @@ -123,16 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +The name of the policy being assigned. To remove an existing user level policy assignment, specify PolicyName as $null. ```yaml Type: String -Parameter Sets: (GrantToGroup) +Parameter Sets: (All) Aliases: -Required: True -Position: 0 +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsChannelsPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsChannelsPolicy.md index abfbdfe908..2c5183974c 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsChannelsPolicy.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy applicable: Microsoft Teams -title: Grant-CsTeamsChannelsPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy +schema: 2.0.0 +title: Grant-CsTeamsChannelsPolicy --- # Grant-CsTeamsChannelsPolicy ## SYNOPSIS - -The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. +The Grant-CsTeamsChannelsPolicy allows you to assign specific policies to users that have been created in your tenant. ## SYNTAX @@ -37,7 +38,7 @@ Grant-CsTeamsChannelsPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalP ``` ## DESCRIPTION -The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. The Grant-CsTeamsChannelsPolicy allows you to assign specific policies to users that have been created in your tenant. +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. ## EXAMPLES @@ -95,6 +96,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Specify the user to whom the policy is being assigned. @@ -139,12 +155,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -154,28 +170,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Tenant +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup Aliases: Required: False @@ -185,15 +185,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy.md index caa013a167..3acb9a612d 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsComplianceRecordingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: Grant-CsTeamsComplianceRecordingPolicy --- # Grant-CsTeamsComplianceRecordingPolicy @@ -73,23 +74,33 @@ As a result, the user will be managed by the global Teams recording policy. ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user Teams recording policy. -User Identities can be specified using one of the following formats: +### -Confirm +Prompts you for confirmation before running the cmdlet. -- The user's SIP address; -- The user's user principal name (UPN); -- The user's Active Directory display name (for example, Ken Myer). +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. ```yaml -Type: UserIdParameter -Parameter Sets: Identity +Type: Fqdn +Parameter Sets: (All) Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -109,57 +120,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -Name of the policy to be assigned. -The PolicyName is simply the policy Identity without the policy scope i.e. the "Tag:" prefix. -For example, a policy with the Identity Tag:ContosoPartnerComplianceRecordingPolicy has a PolicyName equal to ContosoPartnerComplianceRecordingPolicy. - -To revoke a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams recording policy. +User Identities can be specified using one of the following formats: -If you are using a remote session of Windows PowerShell and are connected only to Microsoft Teams or Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. +- The user's SIP address; +- The user's user principal name (UPN); +- The user's Active Directory display name (for example, Ken Myer). ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams recording policy. +By default, the Grant-CsTeamsComplianceRecordingPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: Required: False @@ -169,27 +171,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +Name of the policy to be assigned. +The PolicyName is simply the policy Identity without the policy scope i.e. the "Tag:" prefix. +For example, a policy with the Identity Tag:ContosoPartnerComplianceRecordingPolicy has a PolicyName equal to ContosoPartnerComplianceRecordingPolicy. + +To revoke a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -This parameter is reserved for internal Microsoft use. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -199,29 +205,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams recording policy. -By default, the Grant-CsTeamsComplianceRecordingPolicy cmdlet does not pass objects through the pipeline. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +You can return your tenant ID by running this command: -### -Confirm -Prompts you for confirmation before running the cmdlet. +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Microsoft Teams or Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named diff --git a/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCortanaPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCortanaPolicy.md index ef2205b07d..a65a0f3531 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy applicable: Microsoft Teams -title: Grant-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +schema: 2.0.0 +title: Grant-CsTeamsCortanaPolicy --- # Grant-CsTeamsCortanaPolicy @@ -98,6 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the identity of the user account the policy should be assigned to. User identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -157,21 +173,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Tenant Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" diff --git a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy.md index c86a84aa89..2707e1ed49 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Grant-CsTeamsEmergencyCallRoutingPolicy --- # Grant-CsTeamsEmergencyCallRoutingPolicy @@ -56,6 +58,21 @@ This example assigns the Teams Emergency Call Routing policy (Test) to the membe ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global Sets the parameters of the Global policy instance to the values in the specified policy instance. @@ -162,21 +179,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy.md index 6a5ce3b2a9..ad1be45913 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc, pthota +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy schema: 2.0.0 +title: Grant-CsTeamsEmergencyCallingPolicy --- # Grant-CsTeamsEmergencyCallingPolicy @@ -53,6 +55,21 @@ Assigns the Teams Emergency Calling policy called "SalesTECP" to the Global poli ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global Sets the parameters of the Global policy instance to the values in the specified policy instance. @@ -159,21 +176,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEnhancedEncryptionPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEnhancedEncryptionPolicy.md index 58b0be1886..b9878b9520 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEnhancedEncryptionPolicy.md @@ -1,201 +1,202 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy -title: Grant-CsTeamsEnhancedEncryptionPolicy -author: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Grant-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Cmdlet to assign a specific Teams enhanced encryption Policy to a user. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ][-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup -``` -Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] -Group [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Cmdlet to assign a specific Teams enhanced encryption Policy to a user. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsEnhancedEncryptionPolicy' -``` - -The command shown in Example 1 assigns the per-user Teams enhanced encryption policy, ContosoPartnerTeamsEnhancedEncryptionPolicy, to the user with the user principal name (UPN) "KenMyer@contoso.com". - -### EXAMPLE 2 -```PowerShell -PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'Ken Myer' -PolicyName $null -``` - -In Example 2, any per-user Teams enhanced encryption policy previously assigned to the user "Ken Myer" is revoked. - -As a result, the user will be managed by the global Teams enhanced encryption policy. - -## PARAMETERS - -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Global -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Grant-CsTeamsEnhancedEncryptionPolicy +--- + +# Grant-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ][-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] -Group [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsEnhancedEncryptionPolicy' +``` + +The command shown in Example 1 assigns the per-user Teams enhanced encryption policy, ContosoPartnerTeamsEnhancedEncryptionPolicy, to the user with the user principal name (UPN) "KenMyer@contoso.com". + +### EXAMPLE 2 +```PowerShell +PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'Ken Myer' -PolicyName $null +``` + +In Example 2, any per-user Teams enhanced encryption policy previously assigned to the user "Ken Myer" is revoked. + +As a result, the user will be managed by the global Teams enhanced encryption policy. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEnhancedEncryptionPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"). A policy that has an identity of "Tag:ContosoPartnerTeamsEnhancedEncryptionPolicy" has a PolicyName of "ContosoPartnerTeamsEnhancedEncryptionPolicy". If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. For example: Grant-CsTeamsEnhancedEncryptionPolicy -Identity "Ken Myer" -PolicyName $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEventsPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEventsPolicy.md index ad83d722d4..5a3e234c78 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsEventsPolicy.md @@ -1,207 +1,208 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamseventspolicy -title: Grant-CsTeamsEventsPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsEventsPolicy - -## SYNOPSIS -Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsEventsPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup -``` -Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] - [-Group] [-Rank ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Assigns Teams Events policy to a user, group of users, or the entire tenant. - -TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy DisablePublicWebinars -``` - -The command shown in Example 1 assigns the per-user Teams Events policy, DisablePublicWebinars, to the user with the user principal name (UPN) "user1@contoso.com". - -### Example 2 -```powershell -PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy $null -``` - -The command shown in Example 2 revokes the per-user Teams Events policy for the user with the user principal name (UPN) "user1@contoso.com". As a result, the user will be managed by the global Teams Events policy. - -### Example 3 -```powershell -PS C:\> Grant-CsTeamsEventsPolicy -Group "sales@contoso.com" -Rank 10 -Policy DisablePublicWebinars -``` - -The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "sales@contoso.com". - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the identity of the target user. Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -Use the "Global" Identity if you wish to set the policy for the entire tenant. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. - -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamseventspolicy +schema: 2.0.0 +title: Grant-CsTeamsEventsPolicy +--- + +# Grant-CsTeamsEventsPolicy + +## SYNOPSIS +Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsEventsPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] + [-Group] [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Assigns Teams Events policy to a user, group of users, or the entire tenant. + +TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy DisablePublicWebinars +``` + +The command shown in Example 1 assigns the per-user Teams Events policy, DisablePublicWebinars, to the user with the user principal name (UPN) "user1@contoso.com". + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy $null +``` + +The command shown in Example 2 revokes the per-user Teams Events policy for the user with the user principal name (UPN) "user1@contoso.com". As a result, the user will be managed by the global Teams Events policy. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Group "sales@contoso.com" -Rank 10 -Policy DisablePublicWebinars +``` + +The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "sales@contoso.com". + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy.md index cacbfb5a0b..9399b0fa9e 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFeedbackPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Grant-CsTeamsFeedbackPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfeedbackpolicy +schema: 2.0.0 +title: Grant-CsTeamsFeedbackPolicy --- # Grant-CsTeamsFeedbackPolicy @@ -95,6 +96,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the identity of the user account the policy should be assigned to. @@ -140,12 +156,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: Object -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -155,28 +171,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Tenant +Internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup Aliases: Required: False @@ -186,15 +186,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFilesPolicy.md similarity index 95% rename from teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFilesPolicy.md index 3f44d72269..035f7f86c8 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsFilesPolicy.md @@ -1,207 +1,208 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy -title: Grant-CsTeamsFilesPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsFilesPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsFilesPolicy [] -``` - -### GrantToUser - -```powershell -Grant-CsTeamsFilesPolicy -Identity [[-PolicyName] ] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Group] -Rank [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Global] [-Force] [] -``` - -## DESCRIPTION - -The Teams Files Policy is used to modify files related settings in Microsoft teams. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com -``` - -Assigns a given policy to a user. - -### Example 2 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test -``` - -Assigns a given policy to a group. - -### Example 3 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test -``` - -Assigns a given policy to the tenant. - -### Example 4 - -```powershell -PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test -``` - -Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ - -## PARAMETERS - -### -Force - -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -This is the equivalent to `-Identity Global`. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group - -This is the identifier of the group that the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the identity of the target user. - -Example: - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -Use the "Global" Identity if you wish to set the policy for the entire tenant. - -```yaml -Type: String -Parameter Sets: GrantToUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PolicyName - -Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - -```yaml -Type: String -Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank - -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) - -[Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) - -[Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) - -[Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) - -[New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy +schema: 2.0.0 +title: Grant-CsTeamsFilesPolicy +--- + +# Grant-CsTeamsFilesPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsFilesPolicy [] +``` + +### GrantToUser + +```powershell +Grant-CsTeamsFilesPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Group] -Rank [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION + +The Teams Files Policy is used to modify files related settings in Microsoft teams. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the target user. + +Example: + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) + +[Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) + +[Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) + +[Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) + +[New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) diff --git a/teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy.md index 4e0833c5a5..b158ce7b29 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsipphonepolicy applicable: Microsoft Teams -title: Grant-CsTeamsIPPhonePolicy author: tonywoodruff +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsipphonepolicy schema: 2.0.0 +title: Grant-CsTeamsIPPhonePolicy --- # Grant-CsTeamsIPPhonePolicy @@ -98,6 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the identity of the user account the policy should be assigned to. @@ -143,21 +159,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Rank The rank of the policy assignment, relative to other group policy assignments for the same policy type. diff --git a/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaConnectivityPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaConnectivityPolicy.md index 126e7adfd2..242a1db164 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: lirunping-MSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Grant-CsTeamsMediaConnectivityPolicy +ms.author: runli online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMediaConnectivityPolicy schema: 2.0.0 -author: lirunping-MSFT -ms.author: runli +title: Grant-CsTeamsMediaConnectivityPolicy --- # Grant-CsTeamsMediaConnectivityPolicy diff --git a/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaLoggingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaLoggingPolicy.md index 960fd62910..7f955c4c20 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMediaLoggingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsMediaLoggingPolicy author: LeoKuhorev -ms.author: leokukharau +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US manager: shalages +Module Name: MicrosoftTeams +ms.author: leokukharau +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy schema: 2.0.0 +title: Grant-CsTeamsMediaLoggingPolicy --- # Grant-CsTeamsMediaLoggingPolicy @@ -77,39 +78,30 @@ Unassign Teams Media Logging policy from the entire tenant. ## PARAMETERS -### -Identity - -Specifies the identity of the target user. -Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com - -Example: 98403f08-577c-46dd-851a-f0460a13b03d +### -Confirm -Use the "Global" Identity if you wish to set the policy for the entire tenant. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Global -Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. +When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: applicable: Microsoft Teams @@ -120,72 +112,80 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName - -Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - -Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". - -If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: -applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global +### -Identity -When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". +Specifies the identity of the target user. +Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: String +Parameter Sets: Identity Aliases: applicable: Microsoft Teams Required: False -Position: Named -Default value: False -Accept pipeline input: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf +### -PassThru -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsMediaLoggingPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), e.g. a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +Note that Teams Media Logging policy has only one instance that has PolicyName "Enabled". + +If you set PolicyName to a null value, the command will unassign any individual policy assigned to the user. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: +applicable: Microsoft Teams -Required: True -Position: Named +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -206,14 +206,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -WhatIf -Prompts you for confirmation before running the cmdlet. +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi applicable: Microsoft Teams Required: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy.md index cd29d655c1..9232ddf834 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Grant-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # Grant-CsTeamsMeetingBrandingPolicy @@ -54,6 +54,21 @@ In this example, the command will assign TeamsMeetingBrandingPolicy with the nam ## PARAMETERS +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Global Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. @@ -129,21 +144,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy.md similarity index 89% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy.md index 1fac390b29..07b7f2fefc 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingBroadcastPolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbroadcastpolicy applicable: Microsoft Teams -title: Grant-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Grant-CsTeamsMeetingBroadcastPolicy --- # Grant-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS -Grant-CsTeamsMeetingBroadcastPolicy \[\[-Identity\] \\] \[-PolicyName\] \ \[-Tenant \\] \[-DomainController \\] \[-PassThru\] \[-WhatIf\] \[-Confirm\] \[\\] - -Grant-CsTeamsMeetingBroadcastPolicy \[-PolicyName\] \ \[-Tenant \\] \[-DomainController \\] \[-PassThru\] \[-Global\] \[-WhatIf\] \[-Confirm\] \[\\] +Use this cmdlet to assign a policy to a user. ## SYNTAX @@ -38,7 +38,7 @@ Grant-CsTeamsMeetingBroadcastPolicy [-PassThru] [[-PolicyName] ] ``` ## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to assign a policy to a user. +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## EXAMPLES @@ -88,6 +88,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -147,21 +162,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Tenant ```yaml diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingPolicy.md index 555e7a9518..9928753c7e 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingpolicy +schema: 2.0.0 +title: Grant-CsTeamsMeetingPolicy --- # Grant-CsTeamsMeetingPolicy @@ -63,60 +65,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". ```yaml -Type: UserIdParameter -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: -applicable: Microsoft Teams Required: False -Position: 0 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: GrantToGroup Aliases: -applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. +### -Identity +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. ```yaml -Type: String +Type: UserIdParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". +### -PassThru ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant +Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -125,16 +126,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. ```yaml Type: String -Parameter Sets: GrantToGroup +Parameter Sets: (All) Aliases: +applicable: Microsoft Teams -Required: True -Position: Named +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md index 591125a048..f9c8fbce04 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Grant-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Grant-CsTeamsMeetingTemplatePermissionPolicy --- # Grant-CsTeamsMeetingTemplatePermissionPolicy @@ -54,15 +55,16 @@ Assigns a given policy to a user. ## PARAMETERS -### -PolicyName +### -Force -Specifies the Identity of the policy to assign to the user or group. +> Applicable: Microsoft Teams + +Forces the policy assignment. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -70,16 +72,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity +### -Global -This is the identifier of the user that the policy should be assigned to. +> Applicable: Microsoft Teams + +This is the equivalent to `-Identity Global`. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -88,13 +91,14 @@ Accept wildcard characters: False ### -Group +> Applicable: Microsoft Teams + This is the identifier of the group that the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -102,31 +106,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Global +### -Identity -This is the equivalent to `-Identity Global`. +> Applicable: Microsoft Teams + +This is the identifier of the user that the policy should be assigned to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -PolicyName -Forces the policy assignment. +> Applicable: Microsoft Teams + +Specifies the Identity of the policy to assign to the user or group. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMessagingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMessagingPolicy.md index cbe96c09cb..f8818eebf5 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMessagingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmessagingpolicy applicable: Microsoft Teams -title: Grant-CsTeamsMessagingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmessagingpolicy +schema: 2.0.0 +title: Grant-CsTeamsMessagingPolicy --- # Grant-CsTeamsMessagingPolicy @@ -85,21 +87,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Global When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". @@ -130,16 +117,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Identity +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -174,6 +161,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant ```yaml diff --git a/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMobilityPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMobilityPolicy.md index 9ca488f23b..f9511a2a2f 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmobilitypolicy applicable: Microsoft Teams -title: Grant-CsTeamsMobilityPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmobilitypolicy +schema: 2.0.0 +title: Grant-CsTeamsMobilityPolicy --- # Grant-CsTeamsMobilityPolicy @@ -63,89 +65,89 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The User Id of the user to whom the policy is being assigned. +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". ```yaml -Type: UserIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the Global policy, you can assign $Null. +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". +### -Identity +The User Id of the user to whom the policy is being assigned. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the cmdlet does not pass objects through the pipeline. ```yaml -Type: String -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the Global policy, you can assign $Null. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: String +Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. - -By default, the cmdlet does not pass objects through the pipeline. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRecordingRollOutPolicy.md similarity index 97% rename from teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRecordingRollOutPolicy.md index de38261c46..99a9cefefd 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- +applicable: Microsoft Teams +author: ronwa external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams +ms.author: ronwa online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsrecordingrolloutpolicy schema: 2.0.0 -applicable: Microsoft Teams title: Grant-CsTeamsRecordingRollOutPolicy -manager: yujin1 -author: ronwa -ms.author: ronwa --- # Grant-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md index e9460ea3d0..6a1eac544b 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,204 +1,207 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsroomvideoteleconferencingpolicy -title: Grant-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -When you use this cmdlet without specifying a identity, the policy applies to all rooms in your tenant, except any that have an explicit policy assignment. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group - -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The alias of the Teams room that the IT admin is granting this PolicyName to. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Corresponds to the name of the policy under -Identity from the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank - -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Grant-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Grant-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. + +## SYNTAX + +### Identity (Default) + +``` +Grant-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +``` +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +``` +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +When you use this cmdlet without specifying a identity, the policy applies to all rooms in your tenant, except any that have an explicit policy assignment. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The alias of the Teams room that the IT admin is granting this PolicyName to. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Corresponds to the name of the policy under -Identity from the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSharedCallingRoutingPolicy.md similarity index 92% rename from teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSharedCallingRoutingPolicy.md index 4eb7f30ac5..1e14851e75 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- +applicable: Microsoft Teams +author: serdarsoysal external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy -applicable: Microsoft Teams -title: Grant-CsTeamsSharedCallingRoutingPolicy schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: +title: Grant-CsTeamsSharedCallingRoutingPolicy --- # Grant-CsTeamsSharedCallingRoutingPolicy @@ -39,6 +38,9 @@ Grant-CsTeamsSharedCallingRoutingPolicy -Global [[-PolicyName] ] [-Force Grant-CsTeamsSharedCallingRoutingPolicy [-Group] [[-PolicyName] ] -Rank [] ``` +## DESCRIPTION +The `Grant-CsTeamsSharedCallingRoutingPolicy` cmdlet assigns a Teams shared calling routing policy to a user, a group of users, or sets the Global policy instance. This cmdlet is used to manage how calls are routed in Microsoft Teams, allowing administrators to control call handling and routing behavior for users within their organization. + ## EXAMPLES ### EXAMPLE 1 @@ -55,34 +57,20 @@ Example 2 assigns the per-user Teams shared calling routing policy instance Seat ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user Teams shared calling routing policy. User identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's ObjectId or Identity. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +### -Force -### -PolicyName -Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Seattle has a PolicyName equal to Seattle. +> Applicable: Microsoft Teams -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -117,12 +105,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams shared calling routing policy. User identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's ObjectId or Identity. ```yaml -Type: Int32 -Parameter Sets: (GrantToGroup) +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Seattle has a PolicyName equal to Seattle. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + +```yaml +Type: String +Parameter Sets: (All) Aliases: Required: False @@ -132,18 +137,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Type: Int32 +Parameter Sets: (GrantToGroup) +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsShiftsPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsShiftsPolicy.md index 43875faa32..05ad4cf0ce 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsShiftsPolicy.md @@ -1,162 +1,167 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-teamsshiftspolicy -title: Grant-CsTeamsShiftsPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet supports applying the TeamsShiftsPolicy to users in a tenant. - -## SYNTAX - -### Identity (Default) -```powershell -Grant-CsTeamsShiftsPolicy [] -``` - -### GrantToUser -```powershell -Grant-CsTeamsShiftsPolicy [-Identity] [[-PolicyName] ] [] -``` - -### GrantToGroup -```powershell -Grant-CsTeamsShiftsPolicy [[-PolicyName] ] [-Group] [-Rank] [] -``` - -### GrantToTenant -```powershell -Grant-CsTeamsShiftsPolicy [[-PolicyName] ] [-Global] [-Force] [] -``` - -## DESCRIPTION -This cmdlet enables admins to grant Shifts specific policy settings to users in their tenant. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsShiftsPolicy -Identity IsaiahL@mwtdemo.onmicrosoft.com -PolicyName OffShiftAccessMessage1Always -``` -Applies the OffShiftAccessMessage1Always instance of TeamsShiftsPolicy to one user in the tenant. - -## PARAMETERS - -### -Identity -UserId to whom the policy is granted. Email id is acceptable. - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PolicyName -The name of the TeamsShiftsPolicy instance that is being applied to the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named - -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-teamsshiftspolicy +schema: 2.0.0 +title: Grant-CsTeamsShiftsPolicy +--- + +# Grant-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet supports applying the TeamsShiftsPolicy to users in a tenant. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsShiftsPolicy [] +``` + +### GrantToUser +```powershell +Grant-CsTeamsShiftsPolicy [-Identity] [[-PolicyName] ] [] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsShiftsPolicy [[-PolicyName] ] [-Group] [-Rank] [] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsShiftsPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION +This cmdlet enables admins to grant Shifts specific policy settings to users in their tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsShiftsPolicy -Identity IsaiahL@mwtdemo.onmicrosoft.com -PolicyName OffShiftAccessMessage1Always +``` +Applies the OffShiftAccessMessage1Always instance of TeamsShiftsPolicy to one user in the tenant. + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Microsoft Teams + +UserId to whom the policy is granted. Email id is acceptable. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName + +> Applicable: Microsoft Teams + +The name of the TeamsShiftsPolicy instance that is being applied to the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named + +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md index bbe885264d..7064f71d07 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,199 +1,204 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssurvivablebranchappliancepolicy -title: Grant-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] - [] -``` - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group - -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the user. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank - -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Grant-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Grant-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Grants a Survivable Branch Appliance (SBA) Policy to users in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +Grant-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +``` +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +``` +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the user. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpdateManagementPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpdateManagementPolicy.md index d17f961f44..93b45f06f8 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- +applicable: Microsoft Teams +author: vargasj-ms external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: gnamun Module Name: MicrosoftTeams +ms.author: vargasj online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsupdatemanagementpolicy -applicable: Microsoft Teams -title: Grant-CsTeamsUpdateManagementPolicy schema: 2.0.0 -author: vargasj-ms -ms.author: vargasj -manager: gnamun +title: Grant-CsTeamsUpdateManagementPolicy --- # Grant-CsTeamsUpdateManagementPolicy diff --git a/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpgradePolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpgradePolicy.md index 54251476e5..65c814d36e 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsUpgradePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy applicable: Microsoft Teams -title: Grant-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy +schema: 2.0.0 +title: Grant-CsTeamsUpgradePolicy --- # Grant-CsTeamsUpgradePolicy @@ -154,28 +156,29 @@ After running these lines will create an HTML file on the Desktop of the curre ## PARAMETERS -### -Identity - -The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: UserIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: GrantToTenant Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName +### -Global -The name of the policy instance. +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -186,46 +189,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Global - -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: GrantToGroup Aliases: -Required: False -Position: 1 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Identity -Do not use. +The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. ```yaml -Type: Object -Parameter Sets: (All) +Type: UserIdParameter +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -MigrateMeetingsToTeams +Not supported anymore, see the Description section. ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: Boolean +Parameter Sets: (All) Aliases: Required: False @@ -235,44 +235,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the cmdlet does not pass objects through the pipeline. ```yaml -Type: String -Parameter Sets: GrantToGroup +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateMeetingsToTeams -Not supported anymore, see the Description section. +### -PolicyName + +The name of the policy instance. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. - -By default, the cmdlet does not pass objects through the pipeline. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -282,12 +283,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Tenant + +Do not use. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup +Type: Object +Parameter Sets: (All) Aliases: Required: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVdiPolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVdiPolicy.md index 6d3a365fa0..8bc10b77fd 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVdiPolicy.md @@ -1,153 +1,154 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvdipolicy -title: Grant-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsVdiPolicy - -## SYNOPSIS -Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -### Identity (Default) -```powershell -Grant-CsTeamsVdiPolicy [] -``` - -### GrantToUser -```powershell -Grant-CsTeamsVdiPolicy -Identity [[-PolicyName] ] [] -``` - -### GrantToGroup -```powershell -Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Group] -Rank [] -``` - -### GrantToTenant -```powershell -Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Global] [-Force] [] -``` - -## DESCRIPTION -Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsVdiPolicy -identity "Ken Myer" -PolicyName RestrictedUserPolicy -``` - -In this example, a user with identity "Ken Myer" is being assigned the RestrictedUserPolicy - -## PARAMETERS - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. - -```yaml -Type: String -Parameter Sets: GrantToUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. - -```yaml -Type: String -Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvdipolicy +schema: 2.0.0 +title: Grant-CsTeamsVdiPolicy +--- + +# Grant-CsTeamsVdiPolicy + +## SYNOPSIS +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsVdiPolicy [] +``` + +### GrantToUser +```powershell +Grant-CsTeamsVdiPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Group] -Rank [] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsVdiPolicy -identity "Ken Myer" -PolicyName RestrictedUserPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the RestrictedUserPolicy + +## PARAMETERS + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy.md similarity index 96% rename from teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy.md index a6a5f02703..1909ff319e 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVideoInteropServicePolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvideointeropservicepolicy applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Grant-CsTeamsVideoInteropServicePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvideointeropservicepolicy +schema: 2.0.0 +title: Grant-CsTeamsVideoInteropServicePolicy --- # Grant-CsTeamsVideoInteropServicePolicy ## SYNOPSIS - -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. +The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. ## SYNTAX @@ -41,8 +41,6 @@ Grant-CsTeamsVideoInteropServicePolicy [-PassThru] [[-PolicyName] ] ## DESCRIPTION Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. Microsoft provides pre-constructed policies for each of our supported partners that allow you to designate which of the partners to use for cloud video interop. -The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. - User needs to be assigned one policy from admin to create a CVI meeting. There could be multiple provides in a tenant, but user can only be assigned only one policy(provide). **FAQ**: @@ -144,6 +142,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity {{Fill Identity Description}} @@ -189,12 +202,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -204,44 +217,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Tenant +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVirtualAppointmentsPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVirtualAppointmentsPolicy.md index 1203279e74..ade51f3b71 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams +ms.author: erocha online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy -title: Grant-CsTeamsVirtualAppointmentsPolicy schema: 2.0.0 -ms.author: erocha -manager: sonaggarwal -author: emmanuelrocha001 +title: Grant-CsTeamsVirtualAppointmentsPolicy --- # Grant-CsTeamsVirtualAppointmentsPolicy diff --git a/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVoiceApplicationsPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVoiceApplicationsPolicy.md index e97f8b3ab1..43ba512ec2 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy -title: Grant-CsTeamsVoiceApplicationsPolicy schema: 2.0.0 +title: Grant-CsTeamsVoiceApplicationsPolicy --- # Grant-CsTeamsVoiceApplicationsPolicy @@ -51,27 +52,27 @@ Example 2 assigns the per-user online voice routing policy "SDA-Allow-All to all ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user Teams voice applications policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: Required: False @@ -80,64 +81,63 @@ Default value: False Accept pipeline input: False Accept wildcard characters: False ``` - -### -PolicyName -"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. - -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: GrantToGroup Aliases: -Required: False -Position: 2 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter. +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams voice applications policy. User Identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's Active Directory display name (for example, Ken Myer). ```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named -Default value: False -Accept pipeline input: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams voice applications policy. By default, the Grant-CsTeamsVoiceApplicationsPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -PolicyName +"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:SDAAllowAllTeamsVoiceApplicationsPolicy has a PolicyName equal to SDAAllowAllTeamsVoiceApplicationsPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -158,15 +158,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLoadPolicy.md similarity index 94% rename from teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLoadPolicy.md index b6dcf697af..e990c31ac5 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLoadPolicy.md @@ -1,253 +1,254 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy -title: Grant-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Grant-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. - -## SYNTAX - -### Identity (Default) - -```powershell -Grant-CsTeamsWorkLoadPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant - -```powershell -Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] - [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup - -```powershell -Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] - [-Group] [-Rank ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com -``` - -Assigns a given policy to a user. - -### Example 2 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test -``` - -Assigns a given policy to a group. - -### Example 3 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test -``` - -Assigns a given policy to the tenant. - -### Example 4 - -```powershell -PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test -``` - -> [!NOTE] -> _Using `$null` in place of a policy name can be used to unassigned a policy instance._ - - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -This is the equivalent to `-Identity Global`. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group - -This is the identifier of the group that the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the identity of the target user. - -Example: - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -Use the "Global" Identity if you wish to set the policy for the entire tenant. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Microsoft internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName - -Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank - -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy +schema: 2.0.0 +title: Grant-CsTeamsWorkLoadPolicy +--- + +# Grant-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsWorkLoadPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] + [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] + [-Group] [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test +``` + +> [!NOTE] +> _Using `$null` in place of a policy name can be used to unassigned a policy instance._ + + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the target user. + +Example: + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLocationDetectionPolicy.md similarity index 99% rename from teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLocationDetectionPolicy.md index 35c5297361..8f69dfcdf2 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur Module Name: MicrosoftTeams +ms.author: arkozlov online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy -title: Grant-CsTeamsWorkLocationDetectionPolicy schema: 2.0.0 -ms.author: arkozlov -manager: prashibadkur -author: artemiykozlov +title: Grant-CsTeamsWorkLocationDetectionPolicy --- # Grant-CsTeamsWorkLocationDetectionPolicy diff --git a/teams/teams-ps/teams/Grant-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Grant-CsTenantDialPlan.md similarity index 95% rename from teams/teams-ps/teams/Grant-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsTenantDialPlan.md index 9f4245e9a8..31bf39c2fc 100644 --- a/teams/teams-ps/teams/Grant-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan applicable: Microsoft Teams -title: Grant-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan +schema: 2.0.0 +title: Grant-CsTenantDialPlan --- # Grant-CsTenantDialPlan @@ -69,13 +70,15 @@ This example grants the Vt1tenantDialPlan9 dial plan to members of the group sal ## PARAMETERS ### -Global + +> Applicable: Microsoft Teams + Sets the parameters of the Global policy instance to the values in the specified policy instance. ```yaml Type: SwitchParameter Parameter Sets: (GrantToTenant) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -84,82 +87,91 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Group + +> Applicable: Microsoft Teams + +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: (GrantToGroup) Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The PolicyName parameter is the name of the tenant dial plan to be assigned. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter identifies the user to whom the policy should be assigned. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (Identity) Aliases: -Applicable: Microsoft Teams Required: False -Position: 1 +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PassThru + +> Applicable: Microsoft Teams ```yaml -Type: String -Parameter Sets: (GrantToGroup) +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PolicyName + +> Applicable: Microsoft Teams + +The PolicyName parameter is the name of the tenant dial plan to be assigned. ```yaml -Type: Int32 -Parameter Sets: (GrantToGroup) +Type: String +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter identifies the user to whom the policy should be assigned. +### -Rank + +> Applicable: Microsoft Teams + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: String -Parameter Sets: (Identity) +Type: Int32 +Parameter Sets: (GrantToGroup) Aliases: -Applicable: Microsoft Teams Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Grant-CsUserPolicyPackage.md similarity index 97% rename from teams/teams-ps/teams/Grant-CsUserPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Grant-CsUserPolicyPackage.md index 6d4fc120b3..6d7ab9e603 100644 --- a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Grant-CsUserPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: Grant-CsUserPolicyPackage -author: serdarsoysal ms.author: serdars -manager: amitar online version: https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage schema: 2.0.0 +title: Grant-CsUserPolicyPackage --- # Grant-CsUserPolicyPackage @@ -37,15 +38,31 @@ Applies the Education_PrimaryStudent policy package to two users in the tenant. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Microsoft Teams + A list of one or more users in the tenant. Note that there is a limit of 20 users you can apply the package to at a time. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -55,13 +72,14 @@ Accept wildcard characters: False ### -PackageName +> Applicable: Microsoft Teams + The name of a specific policy package to apply. All possible policy package names can be found by running Get-CsPolicyPackage. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None @@ -85,21 +103,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md b/teams/teams-ps/MicrosoftTeams/Import-CsAutoAttendantHolidays.md similarity index 97% rename from teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md rename to teams/teams-ps/MicrosoftTeams/Import-CsAutoAttendantHolidays.md index aee3150e6e..deccd668fa 100644 --- a/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/MicrosoftTeams/Import-CsAutoAttendantHolidays.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays applicable: Microsoft Teams -title: Import-CsAutoAttendantHolidays -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays +schema: 2.0.0 +title: Import-CsAutoAttendantHolidays --- # Import-CsAutoAttendantHolidays @@ -44,7 +46,7 @@ where ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv") Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -Input $bytes @@ -52,7 +54,7 @@ Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -I In this example, the Import-CsAutoAttendantHolidays cmdlet is used to import holiday schedule information from a file at path "C:\Imports\Holidays.csv" to an auto attendant with Identity of 6abea1cd-904b-520b-be96-1092cc096432. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv") Import-CsAutoAttendantHolidays -Identity 6abea1cd-904b-520b-be96-1092cc096432 -Input $bytes | Format-Table -Wrap -AutoSize diff --git a/teams/teams-ps/teams/Import-CsOnlineAudioFile.md b/teams/teams-ps/MicrosoftTeams/Import-CsOnlineAudioFile.md similarity index 97% rename from teams/teams-ps/teams/Import-CsOnlineAudioFile.md rename to teams/teams-ps/MicrosoftTeams/Import-CsOnlineAudioFile.md index 08de362834..8e52707546 100644 --- a/teams/teams-ps/teams/Import-CsOnlineAudioFile.md +++ b/teams/teams-ps/MicrosoftTeams/Import-CsOnlineAudioFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile applicable: Microsoft Teams -title: Import-CsOnlineAudioFile -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile +schema: 2.0.0 +title: Import-CsOnlineAudioFile --- # Import-CsOnlineAudioFile @@ -53,6 +54,9 @@ This example creates a new audio file using the WAV content that has a filename ## PARAMETERS ### -ApplicationId + +> Applicable: Microsoft Teams + The ApplicationId parameter is the identifier for the application which will use this audio file. For example, if the audio file will be used with an Auto Attendant, then it needs to be set to "OrgAutoAttendant". If the audio file will be used with a Call Queue, then it needs to be set to "HuntGroup". If the audio file will be used with Microsoft Teams, then it needs to be set to "TenantGlobal". Supported values: @@ -65,7 +69,6 @@ Supported values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -74,14 +77,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileName -The FileName parameter is the name of the audio file. For example, the file name for the file C:\Media\Welcome.wav is Welcome.wav. +### -Content + +> Applicable: Microsoft Teams + +The Content parameter represents the content of the audio file. Supported formats are WAV (uncompressed, linear PCM with 8/16/32-bit depth in mono or stereo), WMA (mono only), and MP3. The audio file content cannot be more 5MB. ```yaml -Type: String +Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -90,14 +95,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Content -The Content parameter represents the content of the audio file. Supported formats are WAV (uncompressed, linear PCM with 8/16/32-bit depth in mono or stereo), WMA (mono only), and MP3. The audio file content cannot be more 5MB. +### -FileName + +> Applicable: Microsoft Teams + +The FileName parameter is the name of the audio file. For example, the file name for the file C:\Media\Welcome.wav is Welcome.wav. ```yaml -Type: Byte[] +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named diff --git a/teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md b/teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md new file mode 100644 index 0000000000..eba47db99b --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/MicrosoftTeams.md @@ -0,0 +1,1714 @@ +--- +Locale: en-US +Module Guid: d910df43-3ca6-4c9c-a2e3-e9f45a8e2ad9 +Module Name: MicrosoftTeams +title: MicrosoftTeams PowerShell module +--- + +# MicrosoftTeams PowerShell module + +## Description +The following cmdlet references are for Microsoft Teams. + +## MicrosoftTeams Cmdlets + +### [Add-TeamChannelUser](Add-TeamChannelUser.md) +Adds an owner or member to the private channel. + +### [Add-TeamsAppInstallation](Add-TeamsAppInstallation.md) +Add a Teams App to Microsoft Teams. + +### [Add-TeamUser](Add-TeamUser.md) +The `Add-TeamUser` adds an owner or member to the team, and to the unified group which backs the team. + +### [Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) +Use the `Clear-CsOnlineTelephoneNumberOrder` cmdlet to cancel a specific telephone number search order and release the telephone numbers. The telephone numbers can then be available for search and acquire. + +### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md) +Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. + +### [Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) +Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. + +### [Connect-MicrosoftTeams](Connect-MicrosoftTeams.md) +The Connect-MicrosoftTeams cmdlet connects an authenticated account for use with cmdlets from the MicrosoftTeams module. + +### [Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) +This cmdlet prevents provisioning of users in Skype for Business Online for the specified domain. + +### [Disconnect-MicrosoftTeams](Disconnect-MicrosoftTeams.md) +{{Placeholder}} + +### [Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) +This cmdlet enables provisioning of users in Skype for Business Online for the specified domain. + +### [Export-CsAcquiredPhoneNumber](Export-CsAcquiredPhoneNumber.md) +This cmdlet exports the list of phone numbers acquired by Teams Phone tenant. + +### [Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) +Use Export-CsAutoAttendantHolidays cmdlet to export holiday schedules of an existing Auto Attendant (AA). + +### [export-csonlineaudiofile](export-csonlineaudiofile.md) +Use the Export-CsOnlineAudioFile cmdlet to download an existing audio file. + +### [Find-CsGroup](Find-CsGroup.md) +Use the Find-CsGroup cmdlet to search groups. + +### [Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria. + +### [Get-ALLM365TeamsApps](Get-ALLM365TeamsApps.md) +This cmdlet returns all Microsoft Teams apps in the app catalog, including Microsoft, custom, and non-Microsoft apps. + +### [Get-AssociatedTeam](Get-AssociatedTeam.md) +This cmdlet supports retrieving all teams associated with a user, including teams which host shared channels. + +### [Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) +Retrieves information about the application access policy configured for use in the tenant. + +### [Get-CsApplicationMeetingConfiguration](Get-CsApplicationMeetingConfiguration.md) +Retrieves information about the application meeting configuration settings configured for the tenant. + +### [Get-CsAutoAttendant](Get-CsAutoAttendant.md) +Use the Get-CsAutoAttendant cmdlet to get information about your Auto Attendants (AA). + +### [Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) +Use Get-CsAutoAttendantHolidays cmdlet to get the holiday information for an existing Auto Attendant (AA). + +### [Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) +Use Get-CsAutoAttendantStatus cmdlet to get the status of an Auto Attendant (AA) provisioning. + +### [Get-CsAutoAttendantSupportedLanguage](Get-CsAutoAttendantSupportedLanguage.md) +The Get-CsAutoAttendantSupportedLanguage cmdlet gets languages that are supported by the Auto Attendant (AA) service. + +### [Get-CsAutoAttendantSupportedTimeZone](Get-CsAutoAttendantSupportedTimeZone.md) +The Get-CsAutoAttendantSupportedTimeZone cmdlet gets supported time zones for the Auto Attendant (AA) service. + +### [Get-CsAutoAttendantTenantInformation](Get-CsAutoAttendantTenantInformation.md) +Gets the default tenant information for Auto Attendant (AA) feature. + +### [Get-CsBatchPolicyAssignmentOperation](Get-CsBatchPolicyAssignmentOperation.md) +This cmdlet is used to retrieve the status of batch policy assignment operations. + +### [Get-CsBatchTeamsDeploymentStatus](Get-CsBatchTeamsDeploymentStatus.md) +This cmdlet is used to get the status of the batch deployment orchestration. + +### [Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) +Use the `Get-CsCallingLineIdentity` cmdlet to display the Caller ID policies for your organization. + +### [Get-CsCallQueue](Get-CsCallQueue.md) +The Get-CsCallQueue cmdlet returns the identified Call Queues. + +### [Get-CsCloudCallDataConnection](Get-CsCloudCallDataConnection.md) +This cmdlet retrieves an already existing online call data connection. + +### [Get-CsComplianceRecordingForCallQueueTemplate](Get-CsComplianceRecordingForCallQueueTemplate.md) +```powershell Get-CsComplianceRecordingForCallQueueTemplate [-Id ] [] ``` + +### [Get-CsEffectiveTenantDialPlan](Get-CsEffectiveTenantDialPlan.md) +Use the Get-CsEffectiveTenantDialPlan cmdlet to retrieve an effective tenant dial plan. + +### [Get-CsExportAcquiredPhoneNumberStatus](Get-CsExportAcquiredPhoneNumberStatus.md) +This cmdlet shows the status of the [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) cmdlet. + +### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) +Returns information about the external access policies that have been configured for use in your organization. + +### [Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) +This cmdlet is used to return group policy assignments. + +### [Get-CsHybridTelephoneNumber](Get-CsHybridTelephoneNumber.md) +This cmdlet displays information about one or more hybrid telephone numbers. + +### [Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) +Returns a list of all blocked number patterns added to the tenant list. + +### [Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) +Returns a specific or the full list of all number patterns exempt from call blocking. + +### [Get-CsMeetingMigrationStatus](Get-CsMeetingMigrationStatus.md) +You use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of meeting migrations. + +### [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) +Get application instance for the tenant from Microsoft Entra ID. + +### [Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) +Use the Get-CsOnlineApplicationInstanceAssociation cmdlet to get information about the associations setup in your organization. + +### [Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) +Use the Get-CsOnlineApplicationInstanceAssociationStatus cmdlet to get the provisioning status for the associations you have setup in your organization. + +### [Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet retrieves all online audio conferencing routing policies for the tenant. + +### [Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) +Returns information about a specific or all uploaded audio files of a given application type. + +### [Get-CsOnlineDialInConferencingBridge](Get-CsOnlineDialInConferencingBridge.md) +Use the Get-CsOnlineDialInConferencingBridge cmdlet to view the settings on an audio conferencing bridge that is used when Microsoft is the audio conferencing provider. + +### [Get-CsOnlineDialInConferencingLanguagesSupported](Get-CsOnlineDialInConferencingLanguagesSupported.md) +Use the Get-CsOnlineDialInConferencingLanguagesSupported cmdlet to view the list of languages that are supported when an organization uses Microsoft as the dial-in audio conferencing provider. + +### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) +Retrieves the available Dial-in Conferencing policies in the tenant. + +### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) +Use the Get-CsOnlineDialInConferencingServiceNumber cmdlet to return all of the default dial-in service numbers that are assigned to an Office 365 audio conferencing bridge. + +### [Get-CsOnlineDialinConferencingTenantConfiguration](Get-CsOnlineDialinConferencingTenantConfiguration.md) +Use the Get-CsOnlineDialinConferencingTenantConfiguration cmdlet to retrieve the tenant level configuration for dial-in conferencing. + +### [Get-CsOnlineDialInConferencingTenantSettings](Get-CsOnlineDialInConferencingTenantSettings.md) +Use the Get-CsOnlineDialInConferencingTenantSettings cmdlet to retrieve tenant level settings for dial-in conferencing. + +### [Get-CsOnlineDialInConferencingUser](Get-CsOnlineDialInConferencingUser.md) +Use the `Get-CsOnlineDialInConferencingUser` cmdlet to view the properties and settings of users that are enabled for dial-in conferencing and are using Microsoft as their PSTN conferencing provider. + +### [Get-CsOnlineDialOutPolicy](Get-CsOnlineDialOutPolicy.md) +Use the `Get-CsOnlineDialOutPolicy` cmdlet to get all the available outbound calling restriction policies in your organization. + +### [Get-CsOnlineDirectoryTenant](Get-CsOnlineDirectoryTenant.md) +Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve a tenant and associated parameters from the Business Voice Directory. + +### [Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +Use the Get-CsOnlineEnhancedEmergencyServiceDisclaimer cmdlet to determine whether your organization has accepted the terms and conditions of enhanced emergency service. + +### [Get-CsOnlineLisCivicAddress](Get-CsOnlineLisCivicAddress.md) +Use the Get-CsOnlineLisCivicAddress cmdlet to retrieve information about existing emergency civic addresses defined in the Location Information Service (LIS). + +### [Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) +Use the Get-CsOnlineLisLocation cmdlet to retrieve information on previously defined locations in the Location Information Service (LIS.) + +### [Get-CsOnlineLisPort](Get-CsOnlineLisPort.md) +Retrieves one or more ports from the location configuration database. + +### [Get-CsOnlineLisSubnet](Get-CsOnlineLisSubnet.md) +Retrieves one or more subnets from the location configuration database. + +### [Get-CsOnlineLisSwitch](Get-CsOnlineLisSwitch.md) +Retrieves one or more network switches from the location configuration database. + +### [Get-CsOnlineLisWirelessAccessPoint](Get-CsOnlineLisWirelessAccessPoint.md) +Retrieves one or more wireless access points (WAPs) from the location configuration database. + +### [Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) +Shows the configuration of the previously defined Session Border Controller(s) (SBC(s)) that describes the settings for the peer entity. This cmdlet was introduced with Microsoft Phone System Direct Routing. + +### [Get-CsOnlinePstnUsage](Get-CsOnlinePstnUsage.md) +Returns information about online public switched telephone network (PSTN) usage records used in your tenant. + +### [Get-CsOnlineSchedule](Get-CsOnlineSchedule.md) +Use the Get-CsOnlineSchedule cmdlet to get information about schedules that belong to your organization. + +### [Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) +This cmdlet lists online sip domains and their enabled/disabled status. In a disabled domain, provisioning of users is blocked. Once a domain is re-enabled, provisioning of users in that domain will happen. + +### [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) +Use the `Get-CsOnlineTelephoneNumber` to retrieve telephone numbers from the Business Voice Directory. + +### [Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) +Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. + +### [Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) +Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number order. + +### [Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) +Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. + +### [Get-CsOnlineUser](Get-CsOnlineUser.md) +Returns information about users who have accounts homed on Microsoft Teams or Skype for Business Online. + +### [Get-CsOnlineVoicemailPolicy](Get-CsOnlineVoicemailPolicy.md) +Use the `Get-CsOnlineVoicemailPolicy` cmdlet to get a list of all pre-configured policy instances related to Cloud Voicemail service. + +### [Get-CsOnlineVoicemailUserSettings](Get-CsOnlineVoicemailUserSettings.md) +Use the Get-CsOnlineVoicemailUserSettings cmdlet to get information about online voicemail user settings of a specific user. + +### [Get-CsOnlineVoiceRoute](Get-CsOnlineVoiceRoute.md) +Returns information about the online voice routes configured for use in your tenant. + +### [Get-CsOnlineVoiceRoutingPolicy](Get-CsOnlineVoiceRoutingPolicy.md) +Returns information about the online voice routing policies configured for use in your tenant. + +### [Get-CsOnlineVoiceUser](Get-CsOnlineVoiceUser.md) +Use the `Get-CsOnlineVoiceUser` cmdlet to retrieve a voice user's telephone number and location. + +### [Get-CsPhoneNumberAssignment](Get-CsPhoneNumberAssignment.md) +This cmdlet displays information about one or more phone numbers. + +### [Get-CsPhoneNumberTag](Get-CsPhoneNumberTag.md) +This cmdlet allows the admin to get a list of existing tags for telephone numbers. + +### [Get-CsPolicyPackage](Get-CsPolicyPackage.md) +This cmdlet supports retrieving all the policy packages available on a tenant. + +### [Get-CsSdgBulkSignInRequestsSummary](Get-CsSdgBulkSignInRequestsSummary.md) +Get the tenant level summary of all bulk sign in requests executed in the past 30 days. + +### [Get-CsSdgBulkSignInRequestStatus](Get-CsSdgBulkSignInRequestStatus.md) +Get the status of an active bulk sign in request. + +### [Get-CsSharedCallQueueHistoryTemplate](Get-CsSharedCallQueueHistoryTemplate.md) +```powershell Get-CsSharedCallQueueHistoryTemplate -Id [] ``` + +### [Get-CsTeamsAcsFederationConfiguration](Get-CsTeamsAcsFederationConfiguration.md) +This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. + +### [Get-CsTeamsAIPolicy](Get-CsTeamsAIPolicy.md) +This cmdlet retrieves all Teams AI policies for the tenant. + +### [Get-CsTeamsAppPermissionPolicy](Get-CsTeamsAppPermissionPolicy.md) +As an admin, you can use app permission policies to allow or block apps for your users. + +### [Get-CsTeamsAppSetupPolicy](Get-CsTeamsAppSetupPolicy.md) +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. + +### [Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) +Audio conferencing policies can be used to manage audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. + +### [Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) +Returns information about the policies configured to customize the call hold experience for Teams clients. + +### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) +Returns information about the teams calling policies configured for use in your organization. Teams calling policies help determine which users are able to use calling functionality within Microsoft Teams. + +### [Get-CsTeamsCallParkPolicy](Get-CsTeamsCallParkPolicy.md) +The Get-CsTeamsCallParkPolicy cmdlet returns the policies that are available for your organization. + +### [Get-CsTeamsChannelsPolicy](Get-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [Get-CsTeamsClientConfiguration](Get-CsTeamsClientConfiguration.md) +This cmdlet allows IT admins to retrieve the effective configuration for their organization. + +### [Get-CsTeamsComplianceRecordingApplication](Get-CsTeamsComplianceRecordingApplication.md) +Returns information about the application instances of policy-based recording applications that have been configured for administering automatic policy-based recording in your tenant. + +### [Get-CsTeamsComplianceRecordingPolicy](Get-CsTeamsComplianceRecordingPolicy.md) +Returns information about the policies configured for governing automatic policy-based recording in your tenant. Automatic policy-based recording is only applicable to Microsoft Teams users. + +### [Get-CsTeamsCortanaPolicy](Get-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +### [Get-CsTeamsEducationAssignmentsAppPolicy](Get-CsTeamsEducationAssignmentsAppPolicy.md) +This cmdlet allows you to retrieve the current values of your Education Assignments App Policy. + +### [Get-CsTeamsEducationConfiguration](Get-CsTeamsEducationConfiguration.md) +This cmdlet is used to retrieve the organization-wide education configuration for Teams. + +### [Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet returns one or more Emergency Call Routing policies. + +### [Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) +Returns information about the teams enhanced encryption policies configured for use in your organization. + +### [Get-CsTeamsEventsPolicy](Get-CsTeamsEventsPolicy.md) +Returns information about the Teams Events policy. Note that this policy is currently still in preview. + +### [Get-CsTeamsExternalAccessConfiguration](Get-CsTeamsExternalAccessConfiguration.md) +This cmdlet returns the current settings of your organization. + +### [Get-CsTeamsFeedbackPolicy](Get-CsTeamsFeedbackPolicy.md) +Use this cmdlet to retrieve the current Teams Feedback policies (the ability to send feedback about Teams to Microsoft and whether they receive the survey) in the organization. + +### [Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) +Get a list of all pre-configured policy instances related to teams files. + +### [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) +This cmdlet fetches the first-party meeting templates stored on the tenant. + +### [Get-CsTeamsGuestCallingConfiguration](Get-CsTeamsGuestCallingConfiguration.md) +Returns information about the GuestCallingConfiguration, which specifies what options guest users have for calling within Teams. + +### [Get-CsTeamsGuestMeetingConfiguration](Get-CsTeamsGuestMeetingConfiguration.md) +Designates what meeting features guests using Microsoft Teams will have available. + +### [Get-CsTeamsGuestMessagingConfiguration](Get-CsTeamsGuestMessagingConfiguration.md) +TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. This cmdlet returns your organization's current settings. + +### [Get-CsTeamsIPPhonePolicy](Get-CsTeamsIPPhonePolicy.md) +Get-CsTeamsIPPhonePolicy allows IT Admins to view policies for IP Phone experiences in Microsoft Teams. + +### [Get-CsTeamsMediaConnectivityPolicy](Get-CsTeamsMediaConnectivityPolicy.md) +This cmdlet retrieves all Teams media connectivity policies for the current tenant. + +### [Get-CsTeamsMediaLoggingPolicy](Get-CsTeamsMediaLoggingPolicy.md) +Returns information about the Teams Media Logging policy. + +### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [Get-CsTeamsMeetingBroadcastConfiguration](Get-CsTeamsMeetingBroadcastConfiguration.md) +Gets Tenant level configuration for broadcast events in Teams. + +### [Get-CsTeamsMeetingBroadcastPolicy](Get-CsTeamsMeetingBroadcastPolicy.md) +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. + +### [Get-CsTeamsMeetingConfiguration](Get-CsTeamsMeetingConfiguration.md) +The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants. + +### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) +The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +### [Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) +This cmdlet fetches the custom meeting templates stored on the tenant. + +### [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) +Fetches the TeamsMeetingTemplatePermissionPolicy. This policy can be used to hide meeting templates from users and groups. + +### [get-csteamsmessagingconfiguration](get-csteamsmessagingconfiguration.md) +TeamsMessagingConfiguration determines the messaging settings for users. This cmdlet returns your organization's current settings. + +### [Get-CsTeamsMessagingPolicy](Get-CsTeamsMessagingPolicy.md) +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. + +### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Get-CsTeamsMultiTenantOrganizationConfiguration](Get-CsTeamsMultiTenantOrganizationConfiguration.md) +This cmdlet retrieves all tenant settings for Multi-tenant Organizations + +### [Get-CsTeamsNetworkRoamingPolicy](Get-CsTeamsNetworkRoamingPolicy.md) +Get-CsTeamsNetworkRoamingPolicy allows IT Admins to view policies for the Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [Get-CsTeamsNotificationAndFeedsPolicy](Get-CsTeamsNotificationAndFeedsPolicy.md) +Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. + +### [Get-CsTeamsRecordingRollOutPolicy](Get-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Get-CsTeamsRoomVideoTeleConferencingPolicy](Get-CsTeamsRoomVideoTeleConferencingPolicy.md) +Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. + +### [Get-CsTeamsSettingsCustomApp](Get-CsTeamsSettingsCustomApp.md) +Get the Custom Apps Setting's value of Teams Admin Center. + +### [Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) +Use the Get-CsTeamsSharedCallingRoutingPolicy cmdlet to get Teams shared calling routing policy information. Teams shared calling routing policy is used to configure shared calling. + +### [Get-CsTeamsShiftsAppPolicy](Get-CsTeamsShiftsAppPolicy.md) +Returns information about the Teams Shifts App policies that have been configured for use in your organization. + +### [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) +This cmdlet returns the list of existing workforce management (WFM) connections. It can also return the configuration details for a given WFM connection. + +### [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) +This cmdlet supports retrieving the available Shifts Connectors. + +### [Get-CsTeamsShiftsConnectionErrorReport](Get-CsTeamsShiftsConnectionErrorReport.md) +This cmdlet returns the list of all the team mapping error reports. It can also return the configuration details of one mapping error report with its ID provided or other filter parameters. + +### [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +This cmdlet returns the list of existing connection instances. It can also return the configuration details for a given connection instance. + +### [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md) +This cmdlet gets the requested batch mapping operation. + +### [Get-CsTeamsShiftsConnectionSyncResult](Get-CsTeamsShiftsConnectionSyncResult.md) +This cmdlet supports retrieving the list of user details in the mapped teams of last sync. + +### [Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) +This cmdlet supports retrieving the list of team mappings. + +### [Get-CsTeamsShiftsConnectionWfmTeam](Get-CsTeamsShiftsConnectionWfmTeam.md) +This cmdlet supports retrieving the list of available Workforce management (WFM) teams in the connection instance. + +### [Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) +This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. + +### [Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) +This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. + +### [Get-CsTeamsSipDevicesConfiguration](Get-CsTeamsSipDevicesConfiguration.md) +This cmdlet is used to retrieve the organization-wide Teams SIP devices configuration. + +### [Get-CsTeamsSurvivableBranchAppliance](Get-CsTeamsSurvivableBranchAppliance.md) +Gets the Survivable Branch Appliance (SBA) configured in the tenant. + +### [Get-CsTeamsSurvivableBranchAppliancePolicy](Get-CsTeamsSurvivableBranchAppliancePolicy.md) +Get the Survivable Branch Appliance (SBA) Policy defined in the tenant. + +### [Get-CsTeamsTargetingPolicy](Get-CsTeamsTargetingPolicy.md) +The Get-CsTeamsTargetingPolicy cmdlet enables you to return information about all the Tenant tag setting policies that have been configured for use in your organization. + +### [Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) +Fetches the TeamsTemplatePermissionPolicy. This policy can be used to hide Teams templates from users and groups. + +### [Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) +Cmdlet to get an existing number manipulation rule (or list of rules). + +### [Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) +Displays a specific or all treatments for how calls to an unassigned number range should be routed. + +### [Get-CsTeamsUpdateManagementPolicy](Get-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to retrieve the current Teams Update Management policies in the organization. + +### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) +Returns information related to managing the upgrade to Teams from Skype for Business. + +### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) +This cmdlet returns the set of instances of this policy. + +### [Get-CsTeamsVdiPolicy](Get-CsTeamsVdiPolicy.md) +The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. + +### [Get-CsTeamsVideoInteropServicePolicy](Get-CsTeamsVideoInteropServicePolicy.md) +The Get-CsTeamsVideoInteropServicePolicy cmdlet allows you to identify the pre-constructed policies that you can use in your organization. + +### [Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to fetch policy instances of TeamsVirtualAppointmentsPolicy. + +### [Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) +Use the Get-CsTeamsVoiceApplicationsPolicy cmdlet to get Teams voice applications policy information. + +### [Get-CsTeamsWorkLoadPolicy](Get-CsTeamsWorkLoadPolicy.md) +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +### [Get-CsTeamsWorkLocationDetectionPolicy](Get-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to fetch policy instances of TeamsWorkLocationDetectionPolicy. + +### [Get-CsTeamTemplate](Get-CsTeamTemplate.md) +This cmdlet supports retrieving details of a team template available to your tenant given the team template uri. + +### [Get-CsTeamTemplateList](Get-CsTeamTemplateList.md) +Get a list of available team templates + +### [Get-CsTenant](Get-CsTenant.md) +Returns information about the Microsoft Teams or Skype for Business Online tenants that have been configured for use in your organization. + +### [Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) +Use the Get-CsTenantBlockedCallingNumbers cmdlet to retrieve tenant blocked calling numbers setting. + +### [Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) +Use the Get-CsTenantDialPlan cmdlet to retrieve a tenant dial plan. + +### [Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) +Returns information about the federation configuration settings for your Skype for Business Online tenants. + +### [Get-CsTenantLicensingConfiguration](Get-CsTenantLicensingConfiguration.md) +Indicates whether licensing information for the specified tenant is available in the Teams admin center. + +### [Get-CsTenantMigrationConfiguration](Get-CsTenantMigrationConfiguration.md) +Use the Get-CsTenantMigrationConfiguration cmdlet to check if Meeting Migration Service (MMS) is enabled in your organization. + +### [Get-CsTenantNetworkConfiguration](Get-CsTenantNetworkConfiguration.md) +Returns information about the network regions, sites and subnets in the tenant network configuration. + +### [Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) +Returns information about the network region setting in the tenant. + +### [Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) +Returns information about the network site setting in the tenant. + +### [Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) +Returns information about the network subnet setting in the tenant. + +### [Get-CsTenantTrustedIPAddress](Get-CsTenantTrustedIPAddress.md) +Returns information about the external trusted IPs in the tenant. + +### [Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) +This cmdlet will show the call forwarding, simultaneous ringing, call group and delegation settings for a user. + +### [Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md) +This cmdlet is used to return the policy assignments for a user, both directly assigned and inherited from a group. + +### [Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) +This cmdlet supports retrieving the policy package that's assigned to a user. + +### [Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) +This cmdlet supports retrieving recommendations for which policy packages are best suited for a given user. + +### [Get-CsVideoInteropServiceProvider](Get-CsVideoInteropServiceProvider.md) +Get information about the Cloud Video Interop for Teams. + +### [Get-M365TeamsApp](Get-M365TeamsApp.md) +This cmdlet returns app availability and state for the Microsoft Teams app. + +### [Get-M365UnifiedCustomPendingApps](Get-M365UnifiedCustomPendingApps.md) +This cmdlet returns all custom Microsoft Teams apps that are pending review from an IT Admin. + +### [Get-M365UnifiedTenantSettings](Get-M365UnifiedTenantSettings.md) +This cmdlet returns the current tenant settings for a particular tenant + +### [Get-SharedWithTeam](Get-SharedWithTeam.md) +This cmdlet supports retrieving teams with which a specified channel is shared. + +### [Get-SharedWithTeamUser](Get-SharedWithTeamUser.md) +This cmdlet supports retrieving users of a shared with team. + +### [Get-Team](Get-Team.md) +Get Team information based on particular properties. + +### [Get-TeamAllChannel](Get-TeamAllChannel.md) +This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. + +### [Get-TeamChannel](Get-TeamChannel.md) +This cmdlet supports retrieving channels hosted by a team. + +### [Get-TeamChannelUser](Get-TeamChannelUser.md) +Returns users of a channel. + +### [Get-TeamIncomingChannel](Get-TeamIncomingChannel.md) +This cmdlet supports retrieving incoming channels of a team. + +### [Get-TeamsApp](Get-TeamsApp.md) +Returns app information from the Teams tenant app store. + +### [Get-TeamTargetingHierarchyStatus](Get-TeamTargetingHierarchyStatus.md) +Get the status of a hierarchy upload. + +### [Get-TeamUser](Get-TeamUser.md) +Returns users of a team. + +### [Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) +Assigns a per-user application access policy to one or more users. + +### [Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) +Use the `Grant-CsCallingLineIdentity` cmdlet to apply a Caller ID policy to a user account, to a group of users, or to set the tenant Global instance. + +### [Grant-CsDialoutPolicy](Grant-CsDialoutPolicy.md) +Use the `Grant-CsDialoutPolicy` cmdlet to assign the tenant global, a group of users, or a per-user outbound calling restriction policy to one or more users. + +### [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) +Enables you to assign an external access policy to a user or a group of users. + +### [Grant-CsGroupPolicyPackageAssignment](Grant-CsGroupPolicyPackageAssignment.md) +This cmdlet assigns a policy package to a group in a tenant. + +### [Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant. + +### [Grant-CsOnlineVoicemailPolicy](Grant-CsOnlineVoicemailPolicy.md) +Assigns an online voicemail policy to a user account, to a group of users, or set the tenant Global instance. Online voicemail policies manage usages for Voicemail service. + +### [Grant-CsOnlineVoiceRoutingPolicy](Grant-CsOnlineVoiceRoutingPolicy.md) +Assigns a per-user online voice routing policy to one user, a group of users, or sets the Global policy instance. Online voice routing policies manage online PSTN usages for Phone System users. + +### [Grant-CsTeamsAIPolicy](Grant-CsTeamsAIPolicy.md) +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +### [Grant-CsTeamsAppPermissionPolicy](Grant-CsTeamsAppPermissionPolicy.md) +As an admin, you can use app permission policies to allow or block apps for your users. + +### [Grant-CsTeamsAppSetupPolicy](Grant-CsTeamsAppSetupPolicy.md) +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. + +### [Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) +Assigns a Teams audio-conferencing policy at the per-user scope. + +### [Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) +Assigns a per-user Teams call hold policy to one or more users. + +### [Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) +Assigns a specific Teams Calling Policy to a user, a group of users, or sets the Global policy instance. + +### [Grant-CsTeamsCallParkPolicy](Grant-CsTeamsCallParkPolicy.md) +The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. + +### [Grant-CsTeamsChannelsPolicy](Grant-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [Grant-CsTeamsComplianceRecordingPolicy](Grant-CsTeamsComplianceRecordingPolicy.md) +The Grant-CsTeamsChannelsPolicy allows you to assign specific policies to users that have been created in your tenant. + +### [Grant-CsTeamsCortanaPolicy](Grant-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) +This cmdlet assigns a Teams Emergency Calling policy. + +### [Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet assigns a Teams Emergency Call Routing policy. + +### [Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) +Cmdlet to assign a specific Teams enhanced encryption Policy to a user. + +### [Grant-CsTeamsEventsPolicy](Grant-CsTeamsEventsPolicy.md) +Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. + +### [Grant-CsTeamsFeedbackPolicy](Grant-CsTeamsFeedbackPolicy.md) +Use this cmdlet to grant a specific Teams Feedback policy to a user (the ability to send feedback about Teams to Microsoft and whether they receive the survey). + +### [Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +### [Grant-CsTeamsIPPhonePolicy](Grant-CsTeamsIPPhonePolicy.md) +Use the Grant-CsTeamsIPPhonePolicy cmdlet to assign a set of Teams phone policies to a user account or group of user accounts. + +### [Grant-CsTeamsMediaConnectivityPolicy](Grant-CsTeamsMediaConnectivityPolicy.md) +This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant. + +### [Grant-CsTeamsMediaLoggingPolicy](Grant-CsTeamsMediaLoggingPolicy.md) +Assigns Teams Media Logging policy to a user or entire tenant. + +### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +Assigns a teams meeting branding policy at the per-user scope. + +### [Grant-CsTeamsMeetingBroadcastPolicy](Grant-CsTeamsMeetingBroadcastPolicy.md) +Use this cmdlet to assign a policy to a user. + +### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) +Assigns a teams meeting policy at the per-user scope. + +### [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) +This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to users or groups in a tenant. + +### [Grant-CsTeamsMessagingPolicy](Grant-CsTeamsMessagingPolicy.md) +Assigns a teams messaging policy at the per-user scope. Teams messaging policies determine the features and capabilities that can be used in messaging within the teams client. + +### [Grant-CsTeamsMobilityPolicy](Grant-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Grant-CsTeamsRecordingRollOutPolicy](Grant-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Grant-CsTeamsRoomVideoTeleConferencingPolicy](Grant-CsTeamsRoomVideoTeleConferencingPolicy.md) +Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. + +### [Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) +Assigns a specific Teams shared calling routing policy to a user, a group of users, or sets the Global policy instance. + +### [Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) +This cmdlet supports applying the TeamsShiftsPolicy to users in a tenant. + +### [Grant-CsTeamsSurvivableBranchAppliancePolicy](Grant-CsTeamsSurvivableBranchAppliancePolicy.md) +Grants a Survivable Branch Appliance (SBA) Policy to users in the tenant. + +### [Grant-CsTeamsUpdateManagementPolicy](Grant-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to grant a specific Teams Update Management policy to a user. + +### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. + +### [Grant-CsTeamsVdiPolicy](Grant-CsTeamsVdiPolicy.md) +Assigns a teams Vdi policy at the per-user scope. + +### [Grant-CsTeamsVideoInteropServicePolicy](Grant-CsTeamsVideoInteropServicePolicy.md) +The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. + +### [Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet applies an instance of the TeamsVirtualAppointmentsPolicy to users or groups in a tenant. + +### [Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) +Assigns a per-user Teams voice applications policy to one or more users. + +### [Grant-CsTeamsWorkLoadPolicy](Grant-CsTeamsWorkLoadPolicy.md) +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +### [Grant-CsTeamsWorkLocationDetectionPolicy](Grant-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant. + +### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) +Use the Grant-CsTenantDialPlan cmdlet to assign an existing tenant dial plan to a user, to a group of users, or to set the Global policy instance. + +### [Grant-CsUserPolicyPackage](Grant-CsUserPolicyPackage.md) +This cmdlet supports applying a policy package to users in a tenant. + +### [Import-CsAutoAttendantHolidays](Import-CsAutoAttendantHolidays.md) +Use Import-CsAutoAttendantHolidays cmdlet to import holiday schedules of an existing Auto Attendant (AA). + +### [Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) +Use the Import-CsOnlineAudioFile cmdlet to upload a new audio file. + +### [New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) +Creates a new application access policy. Application access policy contains a list of application (client) IDs. + +### [New-CsAutoAttendant](New-CsAutoAttendant.md) +Use the New-CsAutoAttendant cmdlet to create a new Auto Attendant (AA). + +### [New-CsAutoAttendantCallableEntity](New-CsAutoAttendantCallableEntity.md) +The New-CsAutoAttendantCallableEntity cmdlet lets you create a callable entity. + +### [New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) +Use the New-CsAutoAttendantCallFlow cmdlet to create a new call flow. + +### [New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md) +Use the `New-CsAutoAttendantCallHandlingAssociation` cmdlet to create a new call handling association. + +### [New-CsAutoAttendantDialScope](New-CsAutoAttendantDialScope.md) +Use New-CsAutoAttendantDialScope cmdlet to create dial-scopes for use with Auto Attendant (AA) service. + +### [New-CsAutoAttendantMenu](New-CsAutoAttendantMenu.md) +The New-CsAutoAttendantMenu cmdlet creates a new menu. + +### [New-CsAutoAttendantMenuOption](New-CsAutoAttendantMenuOption.md) +Use the New-CsAutoAttendantMenuOption cmdlet to create a new menu option. + +### [New-CsAutoAttendantPrompt](New-CsAutoAttendantPrompt.md) +Use the New-CsAutoAttendantPrompt cmdlet to create a new prompt. + +### [New-CsBatchPolicyAssignmentOperation](New-CsBatchPolicyAssignmentOperation.md) +This cmdlet is used to assign or unassign a policy to a batch of users. + +### [New-CsBatchPolicyPackageAssignmentOperation](New-CsBatchPolicyPackageAssignmentOperation.md) +This cmdlet submits an operation that applies a policy package to a batch of users in a tenant. + +### [New-CsBatchTeamsDeployment](New-CsBatchTeamsDeployment.md) +This cmdlet is used to run a batch deployment orchestration. + +### [New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) +Use the New-CsCallingLineIdentity cmdlet to create a new Caller ID policy for your organization. + +### [New-CsCallQueue](New-CsCallQueue.md) +Creates new Call Queue in your Skype for Business Online organization. + +### [New-CsCloudCallDataConnection](New-CsCloudCallDataConnection.md) +This cmdlet creates an online call data connection. + +### [New-CsComplianceRecordingForCallQueueTemplate](New-CsComplianceRecordingForCallQueueTemplate.md) +Use the New-CsComplianceRecordingForCallQueueTemplate cmdlet to create a Compliance Recording for Call Queues template. + +### [New-CsCustomPolicyPackage](New-CsCustomPolicyPackage.md) +This cmdlet creates a custom policy package. + +### [New-CsEdgeAllowAllKnownDomains](New-CsEdgeAllowAllKnownDomains.md) +Enables Skype for Business Online federation with all domains except for those domains included on the blocked domains list. + +### [New-CsEdgeAllowList](New-CsEdgeAllowList.md) +Enables administrators to specify the domains that their users will be allowed to communicate with. + +### [New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) +Used to specify a domain that will be added or removed from the set of domains enabled for federation or the set of domains disabled for federation. + +### [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) +Enables you to create a new external access policy. + +### [New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md) +This cmdlet is used to assign a policy to a security group or distribution list. + +### [New-CsHybridTelephoneNumber](New-CsHybridTelephoneNumber.md) +This cmdlet adds a hybrid telephone number to the tenant. + +### [New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) +Adds a blocked number pattern to the tenant list. + +### [New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) +This cmdlet lets you configure a new number pattern that is exempt from tenant call blocking. + +### [New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) +Creates an application instance in Microsoft Entra ID. + +### [New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) +Use the New-CsOnlineApplicationInstanceAssociation cmdlet to associate either a single or multiple application instances with an application configuration, like auto attendant or call queue. + +### [New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet creates a Online Audio Conferencing Routing Policy. + +### [New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) +Use the New-CsOnlineDateTimeRange cmdlet to create a new date-time range. + +### [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md) +This cmdlet creates a request to upload Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. + +### [New-CsOnlineLisCivicAddress](New-CsOnlineLisCivicAddress.md) +Use the New-CsOnlineLisCivicAddress cmdlet to create a civic address in the Location Information Service (LIS). + +### [New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) +Use the New-CsOnlineLisLocation cmdlet to create a new emergency dispatch location within an existing civic address. + +### [New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) +Creates a new Session Border Controller (SBC) Configuration that describes the settings for the peer entity. + +### [New-CsOnlineSchedule](New-CsOnlineSchedule.md) +Use the New-CsOnlineSchedule cmdlet to create a new schedule. + +### [New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) +Use the `New-CsOnlineTelephoneNumberOrder` cmdlet to create a telephone number search order. + +### [New-CsOnlineTelephoneNumberReleaseOrder](New-CsOnlineTelephoneNumberReleaseOrder.md) +This cmdlet creates a request to release telephone numbers from Microsoft Teams telephone number management inventory. + +### [New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) +The New-CsOnlineTimeRange cmdlet creates a new time range. + +### [New-CsOnlineVoicemailPolicy](New-CsOnlineVoicemailPolicy.md) +Creates a new Online Voicemail policy. + +### [New-CsOnlineVoiceRoute](New-CsOnlineVoiceRoute.md) +Creates a new online voice route. + +### [New-CsOnlineVoiceRoutingPolicy](New-CsOnlineVoiceRoutingPolicy.md) +Creates a new online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. + +### [New-CsSdgBulkSignInRequest](New-CsSdgBulkSignInRequest.md) +Use the New-CsSdgBulkSignInRequest cmdlet to sign in a batch of up to 100 devices. + +### [New-CsSharedCallQueueHistoryTemplate](New-CsSharedCallQueueHistoryTemplate.md) +Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue History template. + +### [New-CsTeamsAIPolicy](New-CsTeamsAIPolicy.md) +This cmdlet creates a Teams AI policy. + +### [New-CsTeamsAppPermissionPolicy](New-CsTeamsAppPermissionPolicy.md) +As an admin, you can use app permission policies to allow or block apps for your users. + +### [New-CsTeamsAppSetupPolicy](New-CsTeamsAppSetupPolicy.md) +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. + +### [New-CsTeamsAudioConferencingPolicy](New-CsTeamsAudioConferencingPolicy.md) +{{Placeholder}} + +### [New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) +Creates a new Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +### [New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) +Use this cmdlet to create a new instance of a Teams Calling Policy. + +### [New-CsTeamsCallParkPolicy](New-CsTeamsCallParkPolicy.md) +The New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. + +### [New-CsTeamsChannelsPolicy](New-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [New-CsTeamsComplianceRecordingApplication](New-CsTeamsComplianceRecordingApplication.md) +Creates a new association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. + +### [New-CsTeamsComplianceRecordingPairedApplication](New-CsTeamsComplianceRecordingPairedApplication.md) +Creates a new association between multiple application instances of policy-based recording applications to achieve application resiliency in automatic policy-based recording scenarios. + +### [New-CsTeamsComplianceRecordingPolicy](New-CsTeamsComplianceRecordingPolicy.md) +Creates a new Teams recording policy for governing automatic policy-based recording in your tenant. + +### [New-CsTeamsCortanaPolicy](New-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +### [New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) +{{Placeholder}} + +### [New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet creates a new Teams Emergency Call Routing policy with one or more emergency number. + +### [New-CsTeamsEmergencyNumber](New-CsTeamsEmergencyNumber.md) +{{Placeholder}} + +### [New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) +Use this cmdlet to create a new Teams enhanced encryption policy. + +### [New-CsTeamsEventsPolicy](New-CsTeamsEventsPolicy.md) +This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. + +### [New-CsTeamsFeedbackPolicy](New-CsTeamsFeedbackPolicy.md) +Use this cmdlet to control whether users in your organization can send feedback about Teams to Microsoft through Give feedback and whether they receive the survey. + +### [New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) +Creates a new teams files policy. + +### [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md) +This cmdlet is used to create a `HiddenMeetingTemplate` object. + +### [New-CsTeamsHiddenTemplate](New-CsTeamsHiddenTemplate.md) +This cmdlet is used to create a `HiddenTemplate` object. + +### [New-CsTeamsIPPhonePolicy](New-CsTeamsIPPhonePolicy.md) +New-CsTeamsIPPhonePolicy allows you to create a policy to manage features related to Teams phone experiences. + +### [New-CsTeamsMediaConnectivityPolicy](New-CsTeamsMediaConnectivityPolicy.md) +This cmdlet creates a Teams media connectivity policy. + +### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [New-CsTeamsMeetingBroadcastPolicy](New-CsTeamsMeetingBroadcastPolicy.md) +Use this cmdlet to create a new policy. + +### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) +The New-CsTeamsMeetingPolicy cmdlet allows administrators to define new meeting policies that can be assigned to particular users to control Teams features related to meetings. + +### [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) +Creates a new instance of the TeamsMeetingTemplatePermissionPolicy. + +### [New-CsTeamsMessagingPolicy](New-CsTeamsMessagingPolicy.md) +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. + +### [New-CsTeamsMobilityPolicy](New-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [New-CsTeamsNetworkRoamingPolicy](New-CsTeamsNetworkRoamingPolicy.md) +New-CsTeamsNetworkRoamingPolicy allows IT Admins to create policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [New-CsTeamsRecordingRollOutPolicy](New-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [New-CsTeamsRoomVideoTeleConferencingPolicy](New-CsTeamsRoomVideoTeleConferencingPolicy.md) +Creates a new TeamsRoomVideoTeleConferencingPolicy. + +### [New-CsTeamsSharedCallingRoutingPolicy](New-CsTeamsSharedCallingRoutingPolicy.md) +Use the New-CsTeamsSharedCallingRoutingPolicy cmdlet to configure a shared calling routing policy. + +### [New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) +This cmdlet creates a new workforce management (WFM) connection. + +### [New-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.md) +This cmdlet submits an operation connecting multiple Microsoft Teams teams and Workforce management (WFM) teams. + +### [New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) +This cmdlet creates a Shifts connection instance. + +### [New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) +This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. + +### [New-CsTeamsSurvivableBranchAppliance](New-CsTeamsSurvivableBranchAppliance.md) +Creates a new Survivable Branch Appliance (SBA) object in the tenant. + +### [New-CsTeamsSurvivableBranchAppliancePolicy](New-CsTeamsSurvivableBranchAppliancePolicy.md) +Creates a new Survivable Branch Appliance (SBA) policy object in the tenant. + +### [New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) +Creates a new instance of the TeamsTemplatePermissionPolicy. + +### [New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) +Cmdlet to create a new telephone number manipulation rule. + +### [New-CsTeamsUnassignedNumberTreatment](New-CsTeamsUnassignedNumberTreatment.md) +Creates a new treatment for how calls to an unassigned number range should be routed. + +### [New-CsTeamsUpdateManagementPolicy](New-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to create Teams Update Management policy. + +### [New-CsTeamsVdiPolicy](New-CsTeamsVdiPolicy.md) +The New-CsTeamsVdiPolicy cmdlet allows administrators to define new Vdi policies that can be assigned to particular users to control Teams features related to meetings on a VDI environment. + +### [New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to create a new instance of the TeamsVirtualAppointmentsPolicy. + +### [New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) +Creates a new Teams voice applications policy. + +### [New-CsTeamsWorkLoadPolicy](New-CsTeamsWorkLoadPolicy.md) +This cmdlet creates a Teams Workload Policy instance for the tenant. + +### [New-CsTeamsWorkLocationDetectionPolicy](New-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to create a new instance of the TeamsWorkLocationDetectionPolicy. + +### [New-CsTeamTemplate](New-CsTeamTemplate.md) +This cmdlet lets you provision a new team template for use in Microsoft Teams. + +### [New-CsTenantDialPlan](New-CsTenantDialPlan.md) +Use the `New-CsTenantDialPlan` cmdlet to create a new tenant dial plan. + +### [New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) +Creates a new network region. + +### [New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) +Creates a new network site. + +### [New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) +Creates a new network subnet. + +### [New-CsTenantTrustedIPAddress](New-CsTenantTrustedIPAddress.md) +Creates a new IP address. + +### [New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) +This cmdlet will add a new delegate for calling in Microsoft Teams. + +### [New-CsVideoInteropServiceProvider](New-CsVideoInteropServiceProvider.md) +Use the New-CsVideoInteropServiceProvider to specify information about a supported CVI partner your organization would like to use. + +### [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) +Creates a new voice normalization rule. + +### [New-Team](New-Team.md) +This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. + +### [New-TeamChannel](New-TeamChannel.md) +Add a new channel to a team. + +### [New-TeamsApp](New-TeamsApp.md) +Creates a new app in the Teams tenant app store. + +### [Register-CsOnlineDialInConferencingServiceNumber](Register-CsOnlineDialInConferencingServiceNumber.md) +The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. + +### [Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) +Deletes an existing application access policy. + +### [Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) +Use the Remove-CsAutoAttendant cmdlet to delete an Auto Attendant (AA). + +### [Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) +Use the `Remove-CsCallingLineIdentity` cmdlet to remove a Caller ID policy from your organization. + +### [Remove-CsCallQueue](Remove-CsCallQueue.md) +The Remove-CsCallQueue cmdlet deletes an existing Call Queue. + +### [Remove-CsComplianceRecordingForCallQueueTemplate](Remove-CsComplianceRecordingForCallQueueTemplate.md) +Use the Remove-CsComplianceRecordingForCallQueueTemplate cmdlet to delete a Compliance Recording for Call Queues template. + +### [Remove-CsCustomPolicyPackage](Remove-CsCustomPolicyPackage.md) +This cmdlet deletes a custom policy package. + +### [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) +Enables you to remove an existing external access policy. + +### [Remove-CsGroupPolicyAssignment](Remove-CsGroupPolicyAssignment.md) +This cmdlet is used to remove a group policy assignment. + +### [Remove-CsHybridTelephoneNumber](Remove-CsHybridTelephoneNumber.md) +This cmdlet removes a hybrid telephone number. + +### [Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) +Removes a blocked number pattern from the tenant list. + +### [Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) +Removes a number pattern exempt from call blocking. + +### [Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) +Use the Remove-CsOnlineApplicationInstanceAssociation cmdlet to remove the association between an application instance and the associated application configuration. + +### [Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet deletes an instance of the Online Audio Conferencing Routing Policy. + +### [Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) +Marks an audio file of application type TenantGlobal for deletion and later removal (within 24 hours). + +### [Remove-CsOnlineDialInConferencingTenantSettings](Remove-CsOnlineDialInConferencingTenantSettings.md) +Use the `Remove-CsOnlineDialInConferencingTenantSettings` cmdlet to revert the tenant level dial-in conferencing settings to their original defaults. + +### [Remove-CsOnlineLisCivicAddress](Remove-CsOnlineLisCivicAddress.md) +Use the Remove-CsOnlineLisCivicAddress cmdlet to delete an existing civic address from the Location Information Server (LIS). + +### [Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) +Use the Remove-CsOnlineLisLocation cmdlet to remove an existing emergency location from the Location Information Service (LIS). + +### [Remove-CsOnlineLisPort](Remove-CsOnlineLisPort.md) +Removes an association between a Location port and a location. This association is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. + +### [Remove-CsOnlineLisSubnet](Remove-CsOnlineLisSubnet.md) +Removes a Location Information Server (LIS) subnet. + +### [Remove-CsOnlineLisSwitch](Remove-CsOnlineLisSwitch.md) +Removes a Location Information Server (LIS) network switch. + +### [Remove-CsOnlineLisWirelessAccessPoint](Remove-CsOnlineLisWirelessAccessPoint.md) +Removes a Location Information Server (LIS) wireless access point (WAP). + +### [Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) +Removes the configuration of the previously defined Session Border Controller(s) (SBC(s)) that describes the settings for the peer entity. + +### [Remove-CsOnlineSchedule](Remove-CsOnlineSchedule.md) +Use the Remove-CsOnlineSchedule cmdlet to remove a schedule. + +### [Remove-CsOnlineTelephoneNumber](Remove-CsOnlineTelephoneNumber.md) +Use the `Remove-CsOnlineTelephoneNumber` cmdlet to remove one or more unassigned telephone numbers from your tenant. + +### [Remove-CsOnlineVoicemailPolicy](Remove-CsOnlineVoicemailPolicy.md) +Deletes an existing Online Voicemail policy or resets the Global policy instance to the default values. + +### [Remove-CsOnlineVoiceRoute](Remove-CsOnlineVoiceRoute.md) +Removes an online voice route. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). + +### [Remove-CsOnlineVoiceRoutingPolicy](Remove-CsOnlineVoiceRoutingPolicy.md) +Deletes an existing online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. + +### [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) +This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). + +### [Remove-CsPhoneNumberTag](Remove-CsPhoneNumberTag.md) +This cmdlet allows admin to remove a tag from phone number. + +### [Remove-CsSharedCallQueueHistoryTemplate](Remove-CsSharedCallQueueHistoryTemplate.md) +```powershell Remove-CsSharedCallQueueHistoryTemplate -Id [] ``` + +### [Remove-CsTeamsAIPolicy](Remove-CsTeamsAIPolicy.md) +This cmdlet deletes a Teams AI policy. + +### [Remove-CsTeamsAppPermissionPolicy](Remove-CsTeamsAppPermissionPolicy.md) +This cmdlet allows you to remove app permission policies that have been created within your organization. + +### [Remove-CsTeamsAppSetupPolicy](Remove-CsTeamsAppSetupPolicy.md) +You can use this cmdlet to remove custom app setup policies. + +### [Remove-CsTeamsAudioConferencingPolicy](Remove-CsTeamsAudioConferencingPolicy.md) +Deletes a custom Teams audio conferencing policy. Audio conferencing policies are used to manage audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. + +### [Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) +Deletes an existing Teams call hold policy in your tenant. + +### [Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) +{{Placeholder}} + +### [Remove-CsTeamsCallParkPolicy](Remove-CsTeamsCallParkPolicy.md) +The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. + +### [Remove-CsTeamsChannelsPolicy](Remove-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. + +### [Remove-CsTeamsComplianceRecordingApplication](Remove-CsTeamsComplianceRecordingApplication.md) +Deletes an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. + +### [Remove-CsTeamsComplianceRecordingPolicy](Remove-CsTeamsComplianceRecordingPolicy.md) +Deletes an existing Teams recording policy that is used to govern automatic policy-based recording in your tenant. Automatic policy-based recording is only applicable to Microsoft Teams users. + +### [Remove-CsTeamsCortanaPolicy](Remove-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) +Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call. + +### [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet removes an existing Teams Emergency Call Routing policy instance. + +### [Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) +Use this cmdlet to remove an existing Teams enhanced encryption policy. + +### [Remove-CsTeamsEventsPolicy](Remove-CsTeamsEventsPolicy.md) +The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. + +### [Remove-CsTeamsFeedbackPolicy](Remove-CsTeamsFeedbackPolicy.md) +Use this cmdlet to remove a Teams Feedback policy from the Tenant. + +### [Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) +Deletes an existing teams files policy or resets the Global policy instance to the default values. + +### [Remove-CsTeamsIPPhonePolicy](Remove-CsTeamsIPPhonePolicy.md) +Use the Remove-CsTeamsIPPhonePolicy cmdlet to remove a custom policy that's been created for controlling Teams phone experiences. + +### [Remove-CsTeamsMediaConnectivityPolicy](Remove-CsTeamsMediaConnectivityPolicy.md) +This cmdlet deletes a Teams media connectivity policy. + +### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [Remove-CsTeamsMeetingBroadcastPolicy](Remove-CsTeamsMeetingBroadcastPolicy.md) +Deletes an existing Teams meeting broadcast policy in your tenant. + +### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) +The `CsTeamsMeetingPolicy` cmdlets removes a previously created TeamsMeetingPolicy. + +### [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) +Deletes an instance of TeamsMeetingTemplatePermissionPolicy. + +### [Remove-CsTeamsMessagingPolicy](Remove-CsTeamsMessagingPolicy.md) +Deletes a custom messaging policy. + +### [Remove-CsTeamsMobilityPolicy](Remove-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Remove-CsTeamsNetworkRoamingPolicy](Remove-CsTeamsNetworkRoamingPolicy.md) +Remove-CsTeamsNetworkRoamingPolicy allows IT Admins to delete policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [Remove-CsTeamsNotificationAndFeedsPolicy](Remove-CsTeamsNotificationAndFeedsPolicy.md) +Deletes an existing Teams Notification and Feeds Policy + +### [Remove-CsTeamsRecordingRollOutPolicy](Remove-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Remove-CsTeamsRoomVideoTeleConferencingPolicy](Remove-CsTeamsRoomVideoTeleConferencingPolicy.md) +Deletes an existing TeamsRoomVideoTeleConferencingPolicy. + +### [Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) +Deletes an existing Teams shared calling routing policy instance. + +### [Remove-CsTeamsShiftsConnection](Remove-CsTeamsShiftsConnection.md) +This cmdlet deletes a Shifts connection. + +### [Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) +This cmdlet deletes a Shifts connection instance. + +### [Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) +This cmdlet removes the mapping between the Microsoft Teams team and workforce management (WFM) team. + +### [Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) +The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. + +### [Remove-CsTeamsShiftsScheduleRecord](Remove-CsTeamsShiftsScheduleRecord.md) +This cmdlet enqueues the clear schedule message. + +### [Remove-CsTeamsSurvivableBranchAppliance](Remove-CsTeamsSurvivableBranchAppliance.md) +Removes a Survivable Branch Appliance (SBA) from the tenant. + +### [Remove-CsTeamsSurvivableBranchAppliancePolicy](Remove-CsTeamsSurvivableBranchAppliancePolicy.md) +Removes a Survivable Branch Appliance (SBA) policy from the tenant. + +### [Remove-CsTeamsTargetingPolicy](Remove-CsTeamsTargetingPolicy.md) +The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. + +### [Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) +Deletes an instance of TeamsTemplatePermissionPolicy. + +### [Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) +Cmdlet to remove an existing number manipulation rule (or list of rules). + +### [Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) +Removes a treatment for how calls to an unassigned number range should be routed. + +### [Remove-CsTeamsUpdateManagementPolicy](Remove-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to remove a Teams Update Management policy from the tenant. + +### [Remove-CsTeamsVdiPolicy](Remove-CsTeamsVdiPolicy.md) +This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. + +### [Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to delete an instance of TeamsVirtualAppointmentsPolicy. + +### [Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) +Deletes an existing Teams voice applications policy. + +### [Remove-CsTeamsWorkLoadPolicy](Remove-CsTeamsWorkLoadPolicy.md) +This cmdlet deletes a Teams Workload Policy instance. + +### [Remove-CsTeamsWorkLocationDetectionPolicy](Remove-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to delete an instance of TeamsWorkLocationDetectionPolicy. + +### [Remove-CsTeamTemplate](Remove-CsTeamTemplate.md) +This cmdlet deletes a specified Team Template from Microsoft Teams. + +### [Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) +Use the `Remove-CsTenantDialPlan` cmdlet to remove a tenant dial plan. + +### [Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) +Use the `Remove-CsTenantNetworkRegion` cmdlet to remove a tenant network region. + +### [Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) +Use the `Remove-CsTenantNetworkSite` cmdlet to remove a tenant network site. + +### [Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) +Use the `Remove-CsTenantNetworkSubnet` cmdlet to remove a tenant network subnet. + +### [Remove-CsTenantTrustedIPAddress](Remove-CsTenantTrustedIPAddress.md) +Use the `Remove-CsTenantTrustedIPAddress` cmdlet to remove a tenant trusted IP address. + +### [Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) +This cmdlet will remove a delegate for calling in Microsoft Teams. + +### [Remove-CsUserLicenseGracePeriod](Remove-CsUserLicenseGracePeriod.md) +The `CsUserLicenseGracePeriod` cmdlet expedites the delicensing operation for the assigned plan(s) of a user or resource account. + +### [Remove-CsVideoInteropServiceProvider](Remove-CsVideoInteropServiceProvider.md) +Use the Remove-CsVideoInteropServiceProvider to remove all provider information about a provider that your organization no longer uses. + +### [Remove-SharedWithTeam](Remove-SharedWithTeam.md) +This cmdlet supports unsharing a channel with a team. + +### [Remove-Team](Remove-Team.md) +This cmdlet deletes a specified Team from Microsoft Teams. NOTE: The associated Office 365 Unified Group will also be removed. + +### [Remove-TeamChannel](Remove-TeamChannel.md) +Delete a Teams channel. + +### [Remove-TeamChannelUser](Remove-TeamChannelUser.md) +Removes a user from a channel in Microsoft Teams. + +### [Remove-TeamsApp](Remove-TeamsApp.md) +Removes an app in the Teams tenant app store. + +### [Remove-TeamTargetingHierarchy](Remove-TeamTargetingHierarchy.md) +Removes the tenant's hierarchy. + +### [Remove-TeamUser](Remove-TeamUser.md) +Remove an owner or member from a team, and from the unified group which backs the team. + +### [Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) +Modifies an existing application access policy. + +### [Set-CsApplicationMeetingConfiguration](Set-CsApplicationMeetingConfiguration.md) +Modifies an existing application meeting configuration for the tenant. + +### [Set-CsAutoAttendant](Set-CsAutoAttendant.md) +Use the Set-CsAutoAttendant cmdlet to modify the properties of an existing Auto Attendant (AA). + +### [Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) +Use the `Set-CsCallingLineIdentity` cmdlet to modify a Caller ID policy in your organization. + +### [Set-CsCallQueue](Set-CsCallQueue.md) +Updates a Call Queue in your Skype for Business Online or Teams organization. + +### [Set-CsComplianceRecordingForCallQueueTemplate](Set-CsComplianceRecordingForCallQueueTemplate.md) +```powershell Set-CsComplianceRecordingForCallQueueTemplate -Instance [] ``` + +### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) +Enables you to modify the properties of an existing external access policy. + +### [Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) +Modifies one or more parameters of a blocked number pattern in the tenant list. + +### [Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) +Modifies one or more parameters of an exempt number pattern in the tenant list. + +### [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) +Updates an application instance in Microsoft Entra ID. + +### [Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. + +### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) +Use the `Set-CsOnlineDialInConferencingBridge` cmdlet to modify the settings of a Microsoft audio conferencing bridge. + +### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) +Use the `Set-CsOnlineDialInConferencingServiceNumber` cmdlet to modify the properties of a dial-in or audio conferencing service number that is used by callers when they dial in to a meeting. + +### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md) +Use the `Set-CsOnlineDialInConferencingTenantSettings` to modify the tenant level settings of dial-in conferencing. + +### [Set-CsOnlineDialInConferencingUser](Set-CsOnlineDialInConferencingUser.md) +Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of a user that has been enabled for Microsoft's audio conferencing service. + +### [Set-CsOnlineEnhancedEmergencyServiceDisclaimer](Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +You can use Get-CsOnlineEnhancedEmergencyServiceDisclaimer to see the status of the emergency service disclaimer. + +### [Set-CsOnlineLisCivicAddress](Set-CsOnlineLisCivicAddress.md) +Use the cmdlet to modify an existing civic address which has not been validated. + +### [Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) +Use the cmdlet to modify an existing emergency dispatch location. + +### [Set-CsOnlineLisPort](Set-CsOnlineLisPort.md) +Creates a Location Information Server (LIS) port, creates an association between a port and a location, or modifies an existing port and its associated location. + +### [Set-CsOnlineLisSubnet](Set-CsOnlineLisSubnet.md) +Creates a Location Information Server (LIS) subnet, creates an association between a subnet and a location, or modifies an existing subnet and its associated location. + +### [Set-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) +Creates a Location Information Server (LIS) switch, creates an association between a switch and a location, or modifies an existing switch and its associated location. + +### [Set-CsOnlineLisWirelessAccessPoint](Set-CsOnlineLisWirelessAccessPoint.md) +Creates a Location Information Server (LIS) wireless access point (WAP), creates an association between a WAP and a location, or modifies an existing WAP and its associated location. + +### [Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) +Modifies the previously defined Session Border Controller (SBC) Configuration that describes the settings for the peer entity. + +### [Set-CsOnlinePstnUsage](Set-CsOnlinePstnUsage.md) +Modifies a set of strings that identify the allowed online public switched telephone network (PSTN) usages. + +### [Set-CsOnlineSchedule](Set-CsOnlineSchedule.md) +Use the Set-CsOnlineSchedule cmdlet to update a schedule. + +### [Set-CsOnlineVoiceApplicationInstance](Set-CsOnlineVoiceApplicationInstance.md) +The cmdlet modifies an application instance in Microsoft Entra ID. + +### [Set-CsOnlineVoicemailPolicy](Set-CsOnlineVoicemailPolicy.md) +Modifies an existing Online Voicemail policy. + +### [Set-CsOnlineVoicemailUserSettings](Set-CsOnlineVoicemailUserSettings.md) +Use the Set-CsOnlineVoicemailUserSettings cmdlet to modify the online voicemail user settings of a specific user. + +### [Set-CsOnlineVoiceRoute](Set-CsOnlineVoiceRoute.md) +Modifies an online voice route. + +### [Set-CsOnlineVoiceRoutingPolicy](Set-CsOnlineVoiceRoutingPolicy.md) +Modifies an existing online voice routing policy. + +### [Set-CsOnlineVoiceUser](Set-CsOnlineVoiceUser.md) +Use the `Set-CsOnlineVoiceUser` cmdlet to set the PSTN specific parameters (like telephone numbers and emergency response locations.) + +### [Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) +This cmdlet will assign a phone number to a user or a resource account (online application instance). + +### [Set-CsPhoneNumberTag](Set-CsPhoneNumberTag.md) +This cmdlet allows the admin to create and assign a tag to a phone number. + +### [Set-CsSharedCallQueueHistoryTemplate](Set-CsSharedCallQueueHistoryTemplate.md) +```powershell Set-CsSharedCallQueueHistoryTemplate -Instance [] ``` + +### [Set-CsTeamsAcsFederationConfiguration](Set-CsTeamsAcsFederationConfiguration.md) +This cmdlet is used to manage the federation configuration between Teams and Azure Communication Services. + +### [Set-CsTeamsAIPolicy](Set-CsTeamsAIPolicy.md) +This cmdlet sets Teams AI policy value for users in the tenant. + +### [Set-CsTeamsAppPermissionPolicy](Set-CsTeamsAppPermissionPolicy.md) +Cmdlet to set the app permission policy for Teams. + +### [Set-CsTeamsAppSetupPolicy](Set-CsTeamsAppSetupPolicy.md) +Cmdlet to set the app setup policy for Teams. + +### [Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) +Audio conferencing policies can be used to manage audio conferencing toll- and toll-free numbers to be displayed in meeting invites created by users within your organization. + +### [Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) +Modifies an existing Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) +Use this cmdlet to update values in existing Teams Calling Policies. + +### [Set-CsTeamsCallParkPolicy](Set-CsTeamsCallParkPolicy.md) +The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. + +### [Set-CsTeamsChannelsPolicy](Set-CsTeamsChannelsPolicy.md) +The CsTeamsChannelsPolicy allows you to manage features related to the Teams and Channels experience within the Teams application. + +### [Set-CsTeamsClientConfiguration](Set-CsTeamsClientConfiguration.md) +Changes the Teams client configuration settings for the specified tenant. + +### [Set-CsTeamsComplianceRecordingApplication](Set-CsTeamsComplianceRecordingApplication.md) +Modifies an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. + +### [Set-CsTeamsComplianceRecordingPolicy](Set-CsTeamsComplianceRecordingPolicy.md) +Modifies an existing Teams recording policy for governing automatic policy-based recording in your tenant. + +### [Set-CsTeamsCortanaPolicy](Set-CsTeamsCortanaPolicy.md) +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +Enables administrators to update a configured custom text on the banner displayed when compliance recording bots start recording the call. + +### [Set-CsTeamsEducationAssignmentsAppPolicy](Set-CsTeamsEducationAssignmentsAppPolicy.md) +This policy is controlled by Global and Teams Service Administrators, and is used to turn on/off certain features only related to the Assignments Service, which runs for tenants with EDU licenses. + +### [Set-CsTeamsEducationConfiguration](Set-CsTeamsEducationConfiguration.md) +This cmdlet is used to manage the organization-wide education configuration for Teams. + +### [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) +{{Placeholder}} + +### [Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) +This cmdlet modifies an existing Teams Emergency Call Routing Policy. + +### [Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +Use this cmdlet to update values in existing Teams enhanced encryption policy. + +### [Set-CsTeamsEventsPolicy](Set-CsTeamsEventsPolicy.md) +This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. + +### [Set-CsTeamsExternalAccessConfiguration](Set-CsTeamsExternalAccessConfiguration.md) +{{Placeholder}} + +### [Set-CsTeamsFeedbackPolicy](Set-CsTeamsFeedbackPolicy.md) +Use this cmdlet to modify a Teams feedback policy (the ability to send feedback about Teams to Microsoft and whether they receive the survey). + +### [Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) +Creates a new teams files policy. + +### [Set-CsTeamsGuestCallingConfiguration](Set-CsTeamsGuestCallingConfiguration.md) +Allows admins to set values in the GuestCallingConfiguration, which specifies what options guest users have for calling within Teams. + +### [Set-CsTeamsGuestMeetingConfiguration](Set-CsTeamsGuestMeetingConfiguration.md) +Designates what meeting features guests using Microsoft Teams will have available. Use this cmdlet to set the configuration. + +### [Set-CsTeamsGuestMessagingConfiguration](Set-CsTeamsGuestMessagingConfiguration.md) +TeamsGuestMessagingConfiguration determines the messaging settings for the guest users. + +### [Set-CsTeamsIPPhonePolicy](Set-CsTeamsIPPhonePolicy.md) +Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing Teams phone policy settings. + +### [Set-CsTeamsMediaConnectivityPolicy](Set-CsTeamsMediaConnectivityPolicy.md) +This cmdlet Set Teams media connectivity policy value for current tenant. + +### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +### [Set-CsTeamsMeetingBroadcastConfiguration](Set-CsTeamsMeetingBroadcastConfiguration.md) +Changes the Teams meeting broadcast configuration settings for the specified tenant. + +### [Set-CsTeamsMeetingBroadcastPolicy](Set-CsTeamsMeetingBroadcastPolicy.md) +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. + +### [Set-CsTeamsMeetingConfiguration](Set-CsTeamsMeetingConfiguration.md) +The CsTeamsMeetingConfiguration cmdlets enable administrators to control the meetings configurations in their tenants. + +### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) +The `CsTeamsMeetingPolicy` cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +### [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) +This cmdlet updates an existing TeamsMeetingTemplatePermissionPolicy. + +### [set-csteamsmessagingconfiguration](set-csteamsmessagingconfiguration.md) +The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. + +### [Set-CsTeamsMessagingPolicy](Set-CsTeamsMessagingPolicy.md) +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. + +### [Set-CsTeamsMobilityPolicy](Set-CsTeamsMobilityPolicy.md) +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +### [Set-CsTeamsMultiTenantOrganizationConfiguration](Set-CsTeamsMultiTenantOrganizationConfiguration.md) +This cmdlet configures the Multi-tenant Organization settings for the tenant. + +### [Set-CsTeamsNetworkRoamingPolicy](Set-CsTeamsNetworkRoamingPolicy.md) +Set-CsTeamsNetworkRoamingPolicy allows IT Admins to create or update policies for Network Roaming and Bandwidth Control experiences in Microsoft Teams. + +### [Set-CsTeamsNotificationAndFeedsPolicy](Set-CsTeamsNotificationAndFeedsPolicy.md) +Modifies an existing Teams Notifications and Feeds Policy + +### [Set-CsTeamsRecordingRollOutPolicy](Set-CsTeamsRecordingRollOutPolicy.md) +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +### [Set-CsTeamsRoomVideoTeleConferencingPolicy](Set-CsTeamsRoomVideoTeleConferencingPolicy.md) +Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. + +### [Set-CsTeamsSettingsCustomApp](Set-CsTeamsSettingsCustomApp.md) +Set the Custom Apps Setting's value of Teams Admin Center. + +### [Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) +Use the Set-CsTeamsSharedCallingRoutingPolicy cmdlet to change a shared calling routing policy instance. + +### [Set-CsTeamsShiftsAppPolicy](Set-CsTeamsShiftsAppPolicy.md) +Allows you to set or update properties of a Teams Shifts App Policy instance. + +### [Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) +This cmdlet sets an existing workforce management (WFM) connection. + +### [Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) +This cmdlet updates a Shifts connection instance. + +### [Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. + +### [Set-CsTeamsSipDevicesConfiguration](Set-CsTeamsSipDevicesConfiguration.md) +This cmdlet is used to manage the organization-wide Teams SIP devices configuration. + +### [Set-CsTeamsSurvivableBranchAppliance](Set-CsTeamsSurvivableBranchAppliance.md) +Changes the Survivable Branch Appliance (SBA) configuration settings for the specified tenant. + +### [Set-CsTeamsSurvivableBranchAppliancePolicy](Set-CsTeamsSurvivableBranchAppliancePolicy.md) +Changes the Survivable Branch Appliance (SBA) Policy configuration settings for the specified tenant. + +### [Set-CsTeamsTargetingPolicy](Set-CsTeamsTargetingPolicy.md) +The Set-CsTeamsTargetingPolicy cmdlet allows administrators to update existing Tenant tag settings that can be assigned to particular teams to control Team features related to tags. + +### [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) +This cmdlet updates an existing TeamsTemplatePermissionPolicy. + +### [Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) +Cmdlet to modify an existing normalization rule. + +### [Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) +Changes a treatment for how calls to an unassigned number range should be routed. + +### [Set-CsTeamsUpdateManagementPolicy](Set-CsTeamsUpdateManagementPolicy.md) +Use this cmdlet to modify a Teams Update Management policy. + +### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) +Manage certain aspects of client behavior for users being upgraded from Skype for Business to Teams. + +### [Set-CsTeamsVdiPolicy](Set-CsTeamsVdiPolicy.md) +The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. + +### [Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) +This cmdlet is used to update an instance of TeamsVirtualAppointmentsPolicy. + +### [Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) +Modifies an existing Teams voice applications policy. + +### [Set-CsTeamsWorkLoadPolicy](Set-CsTeamsWorkLoadPolicy.md) +This cmdlet sets the Teams Workload Policy value for current tenant. + +### [Set-CsTeamsWorkLocationDetectionPolicy](Set-CsTeamsWorkLocationDetectionPolicy.md) +This cmdlet is used to update an instance of TeamsWorkLocationDetectionPolicy. + +### [Set-CsTenantBlockedCallingNumbers](Set-CsTenantBlockedCallingNumbers.md) +Use the Set-CsTenantBlockedCallingNumbers cmdlet to set tenant blocked calling numbers setting. + +### [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) +Use the `Set-CsTenantDialPlan` cmdlet to modify an existing tenant dial plan. + +### [Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) +Manages federation configuration settings for your Skype for Business Online tenants. + +### [Set-CsTenantMigrationConfiguration](Set-CsTenantMigrationConfiguration.md) +Used to enable or disable Meeting Migration Service (MMS). + +### [Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) +Changes the definintion of network regions. + +### [Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) +Changes the definition of network sites. + +### [Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) +Changes the definition of network subnets. + +### [Set-CsTenantTrustedIPAddress](Set-CsTenantTrustedIPAddress.md) +Changes the definition of network IP addresses. + +### [Set-CsUser](Set-CsUser.md) +Modifies Skype for Business properties for an existing user account. + +### [Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) +This cmdlet will change permissions for a delegate for calling in Microsoft Teams. + +### [Set-CsUserCallingSettings](Set-CsUserCallingSettings.md) +This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. + +### [Set-CsVideoInteropServiceProvider](Set-CsVideoInteropServiceProvider.md) +Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. + +### [Set-Team](Set-Team.md) +This cmdlet allows you to update properties of a team, including its displayname, description, and team-specific settings. + +### [Set-TeamArchivedState](Set-TeamArchivedState.md) +This cmdlet is used to freeze all of the team activity, but Teams Administrators and team owners will still be able to add or remove members and update roles. + +### [Set-TeamChannel](Set-TeamChannel.md) +Update Team channels settings. + +### [Set-TeamPicture](Set-TeamPicture.md) +Update the team picture. + +### [Set-TeamsApp](Set-TeamsApp.md) +Updates an app in the Teams tenant app store. + +### [Set-TeamsEnvironmentConfig](Set-TeamsEnvironmentConfig.md) +Sets environment-specific configurations on the local machine and is used to connect to the right environment when running Connect-MicrosoftTeams. + +### [Set-TeamTargetingHierarchy](Set-TeamTargetingHierarchy.md) +Upload a hierarchy to the tenant. + +### [Start-CsExMeetingMigration](Start-CsExMeetingMigration.md) +This cmdlet manually trigger a meeting migration request for the specified user. + +### [Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) +Sync the application instance from Microsoft Entra ID into Agent Provisioning Service. + +### [Test-CsEffectiveTenantDialPlan](Test-CsEffectiveTenantDialPlan.md) +Use the Test-CsEffectiveTenantDialPlan cmdlet to test a tenant dial plan. + +### [Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) +This cmdlet tests the given number against the created (by using New-CsInboundBlockedNumberPattern cmdlet) blocked numbers pattern. + +### [Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) +This cmdlet validates workforce management (WFM) connection settings. + +### [Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) +This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. + +### [Test-CsTeamsUnassignedNumberTreatment](Test-CsTeamsUnassignedNumberTreatment.md) +This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. + +### [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) +Tests a telephone number against a voice normalization rule and returns the number after the normalization rule has been applied. + +### [Unregister-CsOnlineDialInConferencingServiceNumber](Unregister-CsOnlineDialInConferencingServiceNumber.md) +Unassigns the previously assigned service number as default Conference Bridge number. + +### [Update-CsAutoAttendant](Update-CsAutoAttendant.md) +Use Update-CsAutoAttendant cmdlet to force an update of resources associated with an Auto Attendant (AA) provisioning. + +### [Update-CsCustomPolicyPackage](Update-CsCustomPolicyPackage.md) +**Note:** This cmdlet is currently in private preview. This cmdlet updates a custom policy package. + +### [Update-CsPhoneNumberTag](Update-CsPhoneNumberTag.md) +This cmdlet allows admin to update existing telephone number tags. + +### [Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) +This cmdlet updates an existing workforce management (WFM) connection. + +### [Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) +This cmdlet updates Shifts connection instance fields. + +### [Update-CsTeamTemplate](Update-CsTeamTemplate.md) +This cmdlet submits an operation that updates a custom team template with new team template settings. + +### [Update-M365TeamsApp](Update-M365TeamsApp.md) +This cmdlet updates app state and app available values for the Microsoft Teams app. + +### [Update-M365UnifiedCustomPendingApp](Update-M365UnifiedCustomPendingApp.md) +This cmdlet updates the review status for a custom Microsoft Teams app that is pending review from an IT Admin. + +### [Update-M365UnifiedTenantSettings](Update-M365UnifiedTenantSettings.md) +This cmdlet updates tenant settings. diff --git a/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsApplicationAccessPolicy.md similarity index 98% rename from teams/teams-ps/teams/New-CsApplicationAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsApplicationAccessPolicy.md index 1f6d71a39b..4c79f0ed07 100644 --- a/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsApplicationAccessPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy applicable: Microsoft Teams -title: New-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni author: frankpeng7 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: zhengni +Module Name: MicrosoftTeams ms.author: frpeng -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy +schema: 2.0.0 +title: New-CsApplicationAccessPolicy --- # New-CsApplicationAccessPolicy @@ -48,28 +49,28 @@ The command shown above shows how to create a new policy with a list of (three) ## PARAMETERS -### -Identity +### -AppIds -Unique identifier assigned to the policy when it was created. +A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). ```yaml -Type: XdsIdentity +Type: PSListModifier Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AppIds +### -Description -A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). +Specifies the description of the policy. ```yaml -Type: PSListModifier +Type: String Parameter Sets: (All) Aliases: @@ -80,17 +81,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Specifies the description of the policy. +Unique identifier assigned to the policy when it was created. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/New-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendant.md similarity index 98% rename from teams/teams-ps/teams/New-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendant.md index 394233ef02..77d16039a3 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendant applicable: Microsoft Teams -title: New-CsAutoAttendant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendant +schema: 2.0.0 +title: New-CsAutoAttendant --- # New-CsAutoAttendant @@ -47,7 +49,7 @@ You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly creat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity $operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User @@ -84,7 +86,7 @@ This example creates a new AA named _Main auto attendant_ that has the following - The time zone is set to UTC. - An inclusion scope is specified. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity $operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User @@ -128,7 +130,7 @@ This example creates a new AA named _Main auto attendant_ that has the following - The default language is en-US. - The time zone is set to UTC. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell # Create Christmas Schedule $dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" @@ -215,7 +217,7 @@ We can see when we ran the Get-CsOnlineSchedule cmdlet at the end, to get the _C Removing an association between an AA and a schedule is as simple as deleting the CallHandlingAssociation of that schedule in the AA you want to modify. Please refer to [Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) cmdlet documentation for examples on how to do that. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell $aaName = "Main Auto Attendant" $language = "en-US" @@ -268,29 +270,29 @@ This example creates a new AA named _Main auto attendant_ that has the following ## PARAMETERS -### -Name -The Name parameter is a friendly name that is assigned to the AA. +### -AuthorizedUsers +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml -Type: System.String +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LanguageId -The LanguageId parameter is the language that is used to read text-to-speech (TTS) prompts. +### -CallFlows +The CallFlows parameter represents call flows, which are required if they are referenced in the CallHandlingAssociations parameter. -You can query the supported languages using the [`Get-CsAutoAttendantSupportedLanguage`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage) cmdlet. +You can create CallFlows by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. ```yaml -Type: System.String +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -302,13 +304,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeZoneId -The TimeZoneId parameter represents the AA time zone. All schedules are evaluated based on this time zone. +### -CallHandlingAssociations +The CallHandlingAssociations parameter represents the call handling associations. +The AA service uses call handling associations to determine which call flow to execute when a specific schedule is in effect. -You can query the supported timezones using the [`Get-CsAutoAttendantSupportedTimeZone`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone) cmdlet. +You can create CallHandlingAssociations by using the `New-CsAutoAttendantCallHandlingAssociation` cmdlet. ```yaml -Type: System.String +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -338,47 +341,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallFlows -The CallFlows parameter represents call flows, which are required if they are referenced in the CallHandlingAssociations parameter. +### -EnableMainlineAttendant +_Voice applications private preview customers only._ -You can create CallFlows by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +The EnableMainlineAttendant parameter enables Mainline Attendant features for this Auto attendant. + +> [!NOTE] +> 1. The Auto attendant must have a Resource account assigned +> 1. `-LanguageId` options are limited when Mainline Attendant is enabled +> 1. `-VoiceId` choices are limited when Mainline Attendate is enabled +> 1. `-EnableVoiceResponse` will be enabled automatically ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CallHandlingAssociations -The CallHandlingAssociations parameter represents the call handling associations. -The AA service uses call handling associations to determine which call flow to execute when a specific schedule is in effect. - -You can create CallHandlingAssociations by using the `New-CsAutoAttendantCallHandlingAssociation` cmdlet. +### -EnableVoiceResponse +The EnableVoiceResponse parameter indicates whether voice response for AA is enabled. ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Operator -The Operator parameter represents the SIP address or PSTN number of the operator. +### -ExclusionScope +Specifies the users to which call transfers are not allowed through directory lookup feature. +If not specified, no user in the organization is excluded from directory lookup. -You can create callable entities by using the `New-CsAutoAttendantCallableEntity` cmdlet. +Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. ```yaml Type: Object @@ -393,18 +402,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceId -The VoiceId parameter represents the voice that is used to read text-to-speech (TTS) prompts. - -You can query the supported voices by using the `Get-CsAutoAttendantSupportedLanguage` cmdlet. You can determine the default voice for a language by issuing the following command: +### -HideAuthorizedUsers +_Saving an auto attendant configuration through Teams admin center will *remove* this setting._ -``` -$language = Get-CsAutoAttendantSupportedLanguage -Identity "en-US" -$defaultVoice = $language.Voices[0].Id -``` +The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml -Type: System.String +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -416,11 +420,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVoiceResponse -The EnableVoiceResponse parameter indicates whether voice response for AA is enabled. +### -InclusionScope +Specifies the users to which call transfers are allowed through directory lookup feature. +If not specified, all users in the organization can be reached through directory lookup. + +Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -432,56 +439,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMainlineAttendant -_Voice applications private preview customers only._ - -_Saving an auto attendant configuration through Teams admin center will remove this setting._ - -The EnableMainlineAttendant parameter enables Mainline Attendant features for this Auto attendant. +### -LanguageId +The LanguageId parameter is the language that is used to read text-to-speech (TTS) prompts. -> [!NOTE] -> 1. The Auto attendant must have a Resource account assigned -> 1. `-LanguageId` options are limited when Mainline Attendant is enabled - see [put link here]() -> 1. `-VoiceId` choices are limited when Mainline Attendate is enabled - see [put link here]() -> 1. `-EnableVoiceResponse` will be enabled automatically +You can query the supported languages using the [`Get-CsAutoAttendantSupportedLanguage`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage) cmdlet. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InclusionScope -Specifies the users to which call transfers are allowed through directory lookup feature. -If not specified, all users in the organization can be reached through directory lookup. - -Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. +### -Name +The Name parameter is a friendly name that is assigned to the AA. ```yaml -Type: Object +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExclusionScope -Specifies the users to which call transfers are not allowed through directory lookup feature. -If not specified, no user in the organization is excluded from directory lookup. +### -Operator +The Operator parameter represents the SIP address or PSTN number of the operator. -Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. +You can create callable entities by using the `New-CsAutoAttendantCallableEntity` cmdlet. ```yaml Type: Object @@ -496,11 +491,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthorizedUsers -This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +### -Tenant ```yaml -Type: List +Type: System.Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -512,18 +506,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HideAuthorizedUsers -_Saving an auto attendant configuration through Teams admin center will *remove* this setting._ +### -TimeZoneId +The TimeZoneId parameter represents the AA time zone. All schedules are evaluated based on this time zone. -The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +You can query the supported timezones using the [`Get-CsAutoAttendantSupportedTimeZone`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone) cmdlet. ```yaml -Type: List +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -552,10 +546,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -VoiceId +The VoiceId parameter represents the voice that is used to read text-to-speech (TTS) prompts. + +You can query the supported voices by using the `Get-CsAutoAttendantSupportedLanguage` cmdlet. ```yaml -Type: System.Guid +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallFlow.md similarity index 97% rename from teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallFlow.md index f7dd275002..f5131ac0a6 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallFlow.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow applicable: Microsoft Teams -title: New-CsAutoAttendantCallFlow -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow +schema: 2.0.0 +title: New-CsAutoAttendantCallFlow --- # New-CsAutoAttendantCallFlow @@ -15,11 +17,6 @@ ms.reviewer: williamlooney ## SYNOPSIS Use the New-CsAutoAttendantCallFlow cmdlet to create a new call flow. -> [!CAUTION] -> The following configuration parameters will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. -> -> - -RingResourceAccountDelegates - ## SYNTAX ```powershell @@ -29,9 +26,14 @@ New-CsAutoAttendantCallFlow -Name -Menu [-Greetings ] [- ## DESCRIPTION The New-CsAutoAttendantCallFlow cmdlet creates a new call flow for use with the Auto Attendant (AA) service. The AA service uses the call flow to handle inbound calls by playing a greeting (if present), and provide callers with actions through a menu. +> [!CAUTION] +> The following configuration parameters will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. +> +> - -RingResourceAccountDelegates + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -EnableDialByName @@ -40,7 +42,7 @@ $callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu This example creates a new call flow that renders the "Default Menu" menu. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts $menuPrompt -EnableDialByName @@ -52,34 +54,17 @@ This example creates a new call flow that plays a greeting before rendering the ## PARAMETERS -### -Name -The Name parameter represents a unique friendly name for the call flow. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Menu -The Menu parameter identifies the menu to render when the call flow is executed. +### -ForceListenMenuEnabled -You can create a new menu by using the [`New-CsAutoAttendantMenu`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu) cmdlet. +If specified, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection. ```yaml -Type: System.Object +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -111,32 +96,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Menu +The Menu parameter identifies the menu to render when the call flow is executed. + +You can create a new menu by using the [`New-CsAutoAttendantMenu`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu) cmdlet. ```yaml -Type: System.Guid +Type: System.Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ForceListenMenuEnabled - -If specified, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection. +### -Name +The Name parameter represents a unique friendly name for the call flow. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -166,6 +153,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Tenant + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation.md similarity index 97% rename from teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation.md index 0dd8a74ae2..6c5bfd4c72 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallHandlingAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation applicable: Microsoft Teams -title: New-CsAutoAttendantCallHandlingAssociation -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation +schema: 2.0.0 +title: New-CsAutoAttendantCallHandlingAssociation --- # New-CsAutoAttendantCallHandlingAssociation @@ -26,7 +28,7 @@ The `New-CsAutoAttendantCallHandlingAssociation` cmdlet creates a new call handl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $tr = New-CsOnlineTimeRange -Start 09:00 -End 17:00 $schedule = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr) -TuesdayHours @($tr) -WednesdayHours @($tr) -ThursdayHours @($tr) -FridayHours @($tr) -Complement @@ -46,7 +48,7 @@ This example creates the following: - a new after-hours call flow - a new after-hours call handling association -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $tr = New-CsOnlineTimeRange -Start 09:00 -End 17:00 $schedule = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSchedule -MondayHours @($tr) -TuesdayHours @($tr) -WednesdayHours @($tr) -ThursdayHours @($tr) -FridayHours @($tr) -Complement @@ -66,7 +68,7 @@ This example creates the following: - a new after-hours call flow - a disabled after-hours call handling association -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" $schedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) @@ -107,32 +109,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScheduleId -The ScheduleId parameter represents the schedule to be associated with the call flow. - -You can create a schedule by using the [New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) cmdlet. additionally, you can use [Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule) cmdlet to get the schedules configured for your organization. +### -Disable +The Disable parameter, if set, establishes that the call handling association is created as disabled. This parameter can only be used when the Type parameter is set to AfterHours. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -The Type parameter represents the type of the call handling association. Currently, only the following types are supported: +### -ScheduleId +The ScheduleId parameter represents the schedule to be associated with the call flow. -- `AfterHours` -- `Holiday` +You can create a schedule by using the [New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) cmdlet. additionally, you can use [Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule) cmdlet to get the schedules configured for your organization. ```yaml -Type: Object +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -144,11 +143,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Disable -The Disable parameter, if set, establishes that the call handling association is created as disabled. This parameter can only be used when the Type parameter is set to AfterHours. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -160,24 +167,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +### -Type +The Type parameter represents the type of the call handling association. Currently, only the following types are supported: -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. +- `AfterHours` +- `Holiday` ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallableEntity.md similarity index 99% rename from teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallableEntity.md index b496fcaaad..30067e3ee1 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantCallableEntity.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity applicable: Microsoft Teams -title: New-CsAutoAttendantCallableEntity -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity +schema: 2.0.0 +title: New-CsAutoAttendantCallableEntity --- # New-CsAutoAttendantCallableEntity @@ -74,54 +76,56 @@ This example gets an Office 365 group by name using Find-CsGroup cmdlet. Then th ## PARAMETERS -### -Identity -The Identity parameter represents the ID of the callable entity; this can be either a Object ID or a TEL URI. +### -CallPriority +_Saving an auto attendant configuration through Teams admin center will reset the priority to 3 - Normal / Default._ -- Only the Object IDs of users that have Enterprise Voice enabled are supported. -- Only PSTN numbers that are acquired and assigned through Skype for Business Online are supported. +The Call Priority of the MenuOption, only applies when the `Type` is `ApplicationEndpoint` or `ConfigurationEndpoint`. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 + +1 = Very High +2 = High +3 = Normal / Default +4 = Low +5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: System.String +Type: Int16 Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: 3 Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -The Type parameter represents the type of the callable entity, which can be any of the following: - -- User -- ApplicationEndpoint (when transferring to a Resource Account) -- ConfigurationEndpoint (when transferring directly to a nested Auto Attendant or Call Queue) -- ExternalPstn -- SharedVoicemail - -> [!IMPORTANT] -> Nesting Auto attendants and Call queues via ***ConfigurationEndpoint*** isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. If you nest an Auto attendant or Call queue without a resource account, authorized users can't edit the auto attendant or call queue. +### -EnableSharedVoicemailSystemPromptSuppression +Suppresses the "Please leave a message after the tone" system prompt when transferring to shared voicemail. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -EnableTranscription +Enables the email transcription of voicemail, this is only supported with shared voicemail callable entities. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -133,27 +137,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTranscription -Enables the email transcription of voicemail, this is only supported with shared voicemail callable entities. +### -Identity +The Identity parameter represents the ID of the callable entity; this can be either a Object ID or a TEL URI. + +- Only the Object IDs of users that have Enterprise Voice enabled are supported. +- Only PSTN numbers that are acquired and assigned through Skype for Business Online are supported. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSharedVoicemailSystemPromptSuppression -Suppresses the "Please leave a message after the tone" system prompt when transferring to shared voicemail. +### -Tenant ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -165,31 +171,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallPriority -_Saving an auto attendant configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -The Call Priority of the MenuOption, only applies when the `Type` is `ApplicationEndpoint` or `ConfigurationEndpoint`. - -PARAMVALUE: 1 | 2 | 3 | 4 | 5 +### -Type +The Type parameter represents the type of the callable entity, which can be any of the following: -1 = Very High -2 = High -3 = Normal / Default -4 = Low -5 = Very Low +- User +- ApplicationEndpoint (when transferring to a Resource Account) +- ConfigurationEndpoint (when transferring directly to a nested Auto Attendant or Call Queue) +- ExternalPstn +- SharedVoicemail > [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +> Nesting Auto attendants and Call queues via ***ConfigurationEndpoint*** isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. If you nest an Auto attendant or Call queue without a resource account, authorized users can't edit the auto attendant or call queue. ```yaml -Type: Int16 +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantDialScope.md similarity index 95% rename from teams/teams-ps/teams/New-CsAutoAttendantDialScope.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantDialScope.md index acea07c42e..5495e6053c 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantDialScope.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope applicable: Microsoft Teams -title: New-CsAutoAttendantDialScope -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope +schema: 2.0.0 +title: New-CsAutoAttendantDialScope --- # New-CsAutoAttendantDialScope @@ -28,7 +30,7 @@ This cmdlet creates a new dial-scope to be used with Auto Attendant (AA) service ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $groupIds = @("00000000-0000-0000-0000-000000000000") $dialScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $groupIds @@ -36,7 +38,7 @@ $dialScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $groupIds In Example 1, the New-CsAutoAttendantDialScope cmdlet is used to create a dial-scope with a group whose id is 00000000-0000-0000-0000-000000000000. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $groupIds = Find-CsGroup -SearchQuery "Contoso Sales" | % { $_.Id } $dialScope = New-CsAutoAttendantDialScope -GroupScope -GroupIds $groupIds @@ -46,11 +48,13 @@ In Example 2, we use the Find-CsGroup cmdlet to find groups with name "Contoso S ## PARAMETERS -### -GroupScope -Indicates that a dial-scope based on groups (distribution lists, security groups) is to be created. +### -GroupIds +Refers to the IDs of the groups that are to be included in the dial-scope. + +Group IDs can be obtained by using the Find-CsGroup cmdlet. ```yaml -Type: SwitchParameter +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -62,13 +66,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GroupIds -Refers to the IDs of the groups that are to be included in the dial-scope. - -Group IDs can be obtained by using the Find-CsGroup cmdlet. +### -GroupScope +Indicates that a dial-scope based on groups (distribution lists, security groups) is to be created. ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenu.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenu.md similarity index 97% rename from teams/teams-ps/teams/New-CsAutoAttendantMenu.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenu.md index b6012b8fc6..4582295131 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantMenu.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenu.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu applicable: Microsoft Teams -title: New-CsAutoAttendantMenu -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu +schema: 2.0.0 +title: New-CsAutoAttendantMenu --- # New-CsAutoAttendantMenu @@ -26,7 +28,7 @@ The New-CsAutoAttendantMenu cmdlet creates a new menu for the Auto Attendant (AA ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -EnableDialByName -DirectorySearchMethod ByExtension @@ -34,7 +36,7 @@ $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -En This example creates a new menu that allows the caller to reach a target by name, and also defines the Directory Search Method to Dial By Extension. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $menuOptionZero = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign. For operator, press zero." @@ -45,11 +47,17 @@ This example creates a new menu that allows the caller to reach a target by name ## PARAMETERS -### -Name -The Name parameter represents a friendly name for the menu. +### -DirectorySearchMethod +The DirectorySearchMethod parameter lets you define the type of Directory Search Method for the Auto Attendant menu, for more information, see [Set up a Cloud auto attendant](https://learn.microsoft.com/MicrosoftTeams/create-a-phone-system-auto-attendant?WT.mc_id=TeamsAdminCenterCSH) + +Possible values are + +- None +- ByName +- ByExtension ```yaml -Type: System.String +Type: Microsoft.Rtc.Management.Hosted.OAA.Models.DirectorySearchMethod Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -61,13 +69,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MenuOptions -The MenuOptions parameter is a list of menu options for this menu. These menu options specify what action to take when the user sends a particular input. - -You can create menu options by using the New-CsAutoAttendantMenuOption cmdlet. +### -EnableDialByName +The EnableDialByName parameter lets users do a directory search by recipient name and get transferred to the party. ```yaml -Type: System.Collections.Generic.List +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -79,16 +85,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Prompts -The Prompts parameter reflects the prompts to play when the menu is activated. - -You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) cmdlet. +### -MenuOptions +The MenuOptions parameter is a list of menu options for this menu. These menu options specify what action to take when the user sends a particular input. -> [!NOTE] -> If Mainline Attendant is enabled, only TTS prompts are supported. +You can create menu options by using the New-CsAutoAttendantMenuOption cmdlet. ```yaml -Type: Object +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -100,38 +103,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDialByName -The EnableDialByName parameter lets users do a directory search by recipient name and get transferred to the party. +### -Name +The Name parameter represents a friendly name for the menu. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DirectorySearchMethod -The DirectorySearchMethod parameter lets you define the type of Directory Search Method for the Auto Attendant menu, for more information, see [Set up a Cloud auto attendant](https://learn.microsoft.com/MicrosoftTeams/create-a-phone-system-auto-attendant?WT.mc_id=TeamsAdminCenterCSH) +### -Prompts +The Prompts parameter reflects the prompts to play when the menu is activated. -Possible values are +You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) cmdlet. -- None -- ByName -- ByExtension +> [!NOTE] +> If Mainline Attendant is enabled, only TTS prompts are supported. ```yaml -Type: Microsoft.Rtc.Management.Hosted.OAA.Models.DirectorySearchMethod +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md similarity index 97% rename from teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md index 3f723b2ff8..a5002f1157 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantMenuOption.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption applicable: Microsoft Teams -title: New-CsAutoAttendantMenuOption -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption +schema: 2.0.0 +title: New-CsAutoAttendantMenuOption --- # New-CsAutoAttendantMenuOption @@ -33,14 +35,14 @@ The New-CsAutoAttendantMenuOption cmdlet creates a new menu option for the Auto ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $menuOption = New-CsAutoAttendantMenuOption -Action TransferCallToOperator -DtmfResponse Tone0 ``` This example creates a menu option to call the operator when the 0 key is pressed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $troubleShootObjectId = (Get-CsOnlineUser troubleShoot@contoso.com).ObjectId $troubleShootEntity = New-CsAutoAttendantCallableEntity -Identity $troubleShootObjectId -Type ApplicationEndpoint @@ -49,7 +51,7 @@ $menuOption = New-CsAutoAttendantMenuOption -Action TransferCallToTarget -DtmfRe This example creates a menu option to transfer the call to an application endpoint when the caller speaks the word "Sales" or presses the 1 key. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $Prompt = New-CsAutoAttendantPrompt -ActiveType TextToSpeech -TextToSpeechPrompt "Our Office is open from Monday to Friday from 9 AM to 5 PM" $menuOption = New-CsAutoAttendantMenuOption -Action Announcement -DtmfResponse Tone2 -VoiceResponses "Hours" -Prompt $Prompt @@ -81,13 +83,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DtmfResponse -The DtmfResponse parameter indicates the key on the telephone keypad to be pressed to activate the menu option. The DtmfResponse must be set to one of the following values: +### -CallTarget +The CallTarget parameter represents the target for call transfer after the menu option is selected. -- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. -- ToneStar - Corresponds to DTMF tone *. -- TonePound - Corresponds to DTMF tone #. -- Automatic - The action is executed without user response. +CallTarget is required if the action of the menu option is TransferCallToTarget. + +Use the New-CsAutoAttendantCallableEntity cmdlet to create new callable entities. ```yaml Type: Object @@ -95,20 +96,26 @@ Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceResponses -The VoiceResponses parameter represents the voice responses to select a menu option when Voice Responses are enabled for the auto attendant. +### -Description +_Voice applications private preview customers only._ -Voice responses are currently limited to one voice response per menu option. +_Saving an auto attendant configuration through Teams admin center will remove this setting._ + +A description/set of keywords for the option. + +Used by Mainline Attendant only. + +Limit: 500 characters ```yaml -Type: System.Collections.Generic.List +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -120,12 +127,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallTarget -The CallTarget parameter represents the target for call transfer after the menu option is selected. - -CallTarget is required if the action of the menu option is TransferCallToTarget. +### -DtmfResponse +The DtmfResponse parameter indicates the key on the telephone keypad to be pressed to activate the menu option. The DtmfResponse must be set to one of the following values: -Use the New-CsAutoAttendantCallableEntity cmdlet to create new callable entities. +- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. +- ToneStar - Corresponds to DTMF tone *. +- TonePound - Corresponds to DTMF tone #. +- Automatic - The action is executed without user response. ```yaml Type: Object @@ -133,46 +141,42 @@ Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Prompt -The **Prompt** parameter reflects the prompts to play when the menu option is activated. +### -MainlineAttendantTarget +_Voice applications private preview customers only._ -You can create new prompts by using the **New-CsAutoAttendantPrompt** cmdlet. +_Saving an auto attendant configuration through Teams admin center will remove this setting._ -This parameter is required if the **Action** is set to **Announcement**. +The Mainline Attendant call flow target identifier. ```yaml -Type: Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True if -Action = MainlineAttendantFlow Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -_Voice applications private preview customers only._ - -_Saving an auto attendant configuration through Teams admin center will remove this setting._ - -A description/set of keywords for the option. +### -Prompt +The **Prompt** parameter reflects the prompts to play when the menu option is activated. -Used by Mainline Attendant only. +You can create new prompts by using the **New-CsAutoAttendantPrompt** cmdlet. -Limit: 500 characters +This parameter is required if the **Action** is set to **Announcement**. ```yaml -Type: System.String +Type: Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -184,30 +188,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MainlineAttendantTarget -_Voice applications private preview customers only._ - -_Saving an auto attendant configuration through Teams admin center will remove this setting._ - -The Mainline Attendant call flow target identifier. +### -Tenant ```yaml -Type: System.String +Type: System.Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True if -Action = MainlineAttendantFlow +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -VoiceResponses +The VoiceResponses parameter represents the voice responses to select a menu option when Voice Responses are enabled for the auto attendant. + +Voice responses are currently limited to one voice response per menu option. ```yaml -Type: System.Guid +Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: applicable: Microsoft Teams diff --git a/teams/teams-ps/teams/New-CsAutoAttendantPrompt.md b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantPrompt.md similarity index 95% rename from teams/teams-ps/teams/New-CsAutoAttendantPrompt.md rename to teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantPrompt.md index 9a601bd5d8..f2a00ad421 100644 --- a/teams/teams-ps/teams/New-CsAutoAttendantPrompt.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsAutoAttendantPrompt.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt applicable: Microsoft Teams -title: New-CsAutoAttendantPrompt -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt +schema: 2.0.0 +title: New-CsAutoAttendantPrompt --- # New-CsAutoAttendantPrompt @@ -37,14 +39,14 @@ The New-CsAutoAttendantPrompt cmdlet creates a new prompt for the Auto Attendant ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $ttsPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" ``` This example creates a new prompt that reads the supplied text. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content @@ -53,7 +55,7 @@ $audioFilePrompt = New-CsAutoAttendantPrompt -AudioFilePrompt $audioFile This example creates a new prompt that plays the selected audio file. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content @@ -102,14 +104,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextToSpeechPrompt -The TextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt that is to be read when the prompt is activated. - -This parameter is required when text to speech prompts are being created. +### -Tenant ```yaml -Type: System.String -Parameter Sets: TextToSpeech, Dual +Type: System.Guid +Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -120,11 +119,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -TextToSpeechPrompt +The TextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt that is to be read when the prompt is activated. + +This parameter is required when text to speech prompts are being created. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: System.String +Parameter Sets: TextToSpeech, Dual Aliases: applicable: Microsoft Teams diff --git a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyAssignmentOperation.md similarity index 99% rename from teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md rename to teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyAssignmentOperation.md index e710dfbc0a..1f6dca775a 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyAssignmentOperation.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation -title: New-CsBatchPolicyAssignmentOperation -schema: 2.0.0 -author: tomkau ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation +schema: 2.0.0 +title: New-CsBatchPolicyAssignmentOperation --- # New-CsBatchPolicyAssignmentOperation @@ -73,56 +74,56 @@ In this example, the batch of users is obtained by connecting to Microsoft Entra ## PARAMETERS -### -Identity -An array of users, specified either using object IDs (guid) or SIP addresses. There is a maximum of 5,000 users per batch. +### -AdditionalParameters +. ```yaml -Type: String +Type: Hashtable Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". +### -Break +Wait for .NET debugger to attach ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -The type of the policy to be assigned to the users. For the list of current policy types accepted by this parameter, see the Description section at the beginning of this article. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline ```yaml -Type: String +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OperationName -An optional name for the batch assignment operation. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline ```yaml -Type: String +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -133,60 +134,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdditionalParameters -. +### -Identity +An array of users, specified either using object IDs (guid) or SIP addresses. There is a maximum of 5,000 users per batch. ```yaml -Type: Hashtable +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach +### -OperationName +An optional name for the batch assignment operation. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -PolicyName +The name of the policy to be assigned to the users. To remove the currently assigned policy, use $null or an empty string "". ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -PolicyType +The type of the policy to be assigned to the users. For the list of current policy types accepted by this parameter, see the Description section at the beginning of this article. ```yaml -Type: SendAsyncStep[] +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyPackageAssignmentOperation.md similarity index 97% rename from teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md rename to teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyPackageAssignmentOperation.md index 7ff16c4092..c51d3eb638 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyPackageAssignmentOperation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsBatchPolicyPackageAssignmentOperation.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: amitar Module Name: MicrosoftTeams -title: New-CsBatchPolicyPackageAssignmentOperation -author: serdarsoysal ms.author: serdars -manager: amitar online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation schema: 2.0.0 +title: New-CsBatchPolicyPackageAssignmentOperation --- # New-CsBatchPolicyPackageAssignmentOperation @@ -37,13 +38,14 @@ Applies the Education_PrimaryStudent policy package to three users in the tenant ### -Identity +> Applicable: Microsoft Teams + A list of one or more users in the tenant. A user identity can either be a user's object id or email address. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 0 Default value: None @@ -53,13 +55,14 @@ Accept wildcard characters: False ### -PackageName +> Applicable: Microsoft Teams + The name of a specific policy package to apply. All policy package names can be found by running Get-CsPolicyPackage. To remove the currently assigned package, use $null or an empty string "". This will not remove any policy assignments, just the package assigned value. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None diff --git a/teams/teams-ps/teams/New-CsBatchTeamsDeployment.md b/teams/teams-ps/MicrosoftTeams/New-CsBatchTeamsDeployment.md similarity index 97% rename from teams/teams-ps/teams/New-CsBatchTeamsDeployment.md rename to teams/teams-ps/MicrosoftTeams/New-CsBatchTeamsDeployment.md index 90392de568..33347e32d8 100644 --- a/teams/teams-ps/teams/New-CsBatchTeamsDeployment.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsBatchTeamsDeployment.md @@ -1,98 +1,99 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment -title: New-CsBatchTeamsDeployment -schema: 2.0.0 ---- - -# New-CsBatchTeamsDeployment - -## SYNOPSIS - -This cmdlet is used to run a batch deployment orchestration. - -## SYNTAX - -``` -New-CsBatchTeamsDeployment -TeamsFilePath -UsersFilePath - -UsersToNotify [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Deploying Teams at scale enables admins to deploy up to 500 teams and add 25 users per team using one Teams PowerShell command and two CSV files. This allows admins to meet your organization's scale needs and significantly reduce deployment time. Admins can also use this solution to add and remove members from existing teams at scale. You can use this cmdlet to: -- Create teams using pre-built templates or your own custom templates. -- Add users to teams as owners or members. -- Manage teams at scale by adding or removing users from existing teams. -- Stay notified through email, including completion, status, and errors (if any). You can choose to notify up to five people about the status of each batch of teams you deploy. Team owners and members are automatically notified when they're added to a team. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-CsBatchTeamsDeployment -TeamsFilePath "C:\dscale\Teams.csv" -UsersFilePath "C:\dscale\Users.csv" -UsersToNotify "adminteams@contoso.com,adelev@contoso.com" -``` -This command runs a batch deployment with the provided parameters in the CSV files and emails the status and errors (if any) to adminteams@contoso.com and adelev@contoso.com. - -## PARAMETERS - -### -TeamsFilePath -The path to the CSV file that defines the teams you're creating. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsersFilePath -The path to the CSV file that maps the users you're adding to each team. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsersToNotify -The email addresses of up to five recipients to notify about this deployment. The recipients will receive email notifications about deployment status. The email contains the orchestration ID for the batch you submitted and any errors that may have occurred. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### OrchestrationId -The ID of the operation that can be used with the Get-CsBatchTeamsDeploymentStatus cmdlet to get the status of the operation. - -## NOTES - -## RELATED LINKS - -[Get-CsBatchTeamsDeploymentStatus](https://learn.microsoft.com/powershell/module/teams/get-csbatchteamsdeploymentstatus) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment +schema: 2.0.0 +title: New-CsBatchTeamsDeployment +--- + +# New-CsBatchTeamsDeployment + +## SYNOPSIS + +This cmdlet is used to run a batch deployment orchestration. + +## SYNTAX + +``` +New-CsBatchTeamsDeployment -TeamsFilePath -UsersFilePath + -UsersToNotify [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deploying Teams at scale enables admins to deploy up to 500 teams and add 25 users per team using one Teams PowerShell command and two CSV files. This allows admins to meet your organization's scale needs and significantly reduce deployment time. Admins can also use this solution to add and remove members from existing teams at scale. You can use this cmdlet to: +- Create teams using pre-built templates or your own custom templates. +- Add users to teams as owners or members. +- Manage teams at scale by adding or removing users from existing teams. +- Stay notified through email, including completion, status, and errors (if any). You can choose to notify up to five people about the status of each batch of teams you deploy. Team owners and members are automatically notified when they're added to a team. + +## EXAMPLES + +### EXAMPLE 1 +``` +New-CsBatchTeamsDeployment -TeamsFilePath "C:\dscale\Teams.csv" -UsersFilePath "C:\dscale\Users.csv" -UsersToNotify "adminteams@contoso.com,adelev@contoso.com" +``` +This command runs a batch deployment with the provided parameters in the CSV files and emails the status and errors (if any) to adminteams@contoso.com and adelev@contoso.com. + +## PARAMETERS + +### -TeamsFilePath +The path to the CSV file that defines the teams you're creating. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersFilePath +The path to the CSV file that maps the users you're adding to each team. For information about the CSV file format, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersToNotify +The email addresses of up to five recipients to notify about this deployment. The recipients will receive email notifications about deployment status. The email contains the orchestration ID for the batch you submitted and any errors that may have occurred. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### OrchestrationId +The ID of the operation that can be used with the Get-CsBatchTeamsDeploymentStatus cmdlet to get the status of the operation. + +## NOTES + +## RELATED LINKS + +[Get-CsBatchTeamsDeploymentStatus](https://learn.microsoft.com/powershell/module/teams/get-csbatchteamsdeploymentstatus) diff --git a/teams/teams-ps/teams/New-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/New-CsCallQueue.md similarity index 99% rename from teams/teams-ps/teams/New-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/New-CsCallQueue.md index d651361f1a..9da50ad683 100644 --- a/teams/teams-ps/teams/New-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCallQueue.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cscallqueue applicable: Microsoft Teams -title: New-CsCallQueue author: tomkau -ms.author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US manager: bulenteg -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: tomkau +online version: https://learn.microsoft.com/powershell/module/teams/new-cscallqueue schema: 2.0.0 +title: New-CsCallQueue --- # New-CsCallQueue @@ -78,22 +79,6 @@ This example creates a Call Queue for the organization named "Help Desk" with mu ## PARAMETERS -### -Name -The Name parameter specifies a unique name for the Call Queue. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AgentAlertTime The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. The default value is 30 seconds. @@ -126,8 +111,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DistributionLists -The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. +### -AuthorizedUsers +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml Type: List @@ -142,8 +127,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for Microsoft internal use only. +### -CallbackEmailNotificationTarget + +The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml Type: Guid @@ -158,11 +144,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDefaultMusicOnHold -The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. +### -CallbackOfferAudioFilePromptResourceId + +The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -174,11 +161,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeMusicAudioFileId -The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. +### -CallbackOfferTextToSpeechPrompt + +The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -190,14 +178,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MusicOnHoldAudioFileId -The MusicOnHoldAudioFileId parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. +### -CallbackRequestDtmf + +The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: + +- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. +- ToneStar - Corresponds to DTMF tone *. +- TonePound - Corresponds to DTMF tone #. + +This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -206,26 +200,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowAction -The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. +### -CallToAgentRatioThresholdBeforeOfferingCallback -PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail +The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Minimum value of 1. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: Object +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: DisconnectWithBusy +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. +### -ChannelId +Id of the channel to connect a call queue to. ```yaml Type: String @@ -240,23 +234,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -If the OverFlowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. - -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low - -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +### -ChannelUserObjectId +Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team the channels belongs to. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -268,45 +250,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowThreshold -The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. +### -ComplianceRecordingForCallQueueTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. ```yaml -Type: Int16 +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: 50 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutAction -The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. +### -ConferenceMode +The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: -PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail +- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. + +- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionTarget -The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. +### -CustomAudioFileAnnouncementForCR +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -318,23 +309,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. +### -CustomAudioFileAnnouncementForCRFailure +_Voice applications private preview customers only._ -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -346,123 +329,104 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutThreshold -The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. -The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. +### -DistributionLists +The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. ```yaml -Type: Int16 +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: 1200 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentApplyTo -The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. - -PARAMVALUE: AllCalls | NewCalls +### -EnableNoAgentSharedVoicemailSystemPromptSuppression +The EnableNoAgentSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentAction -The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. - -PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail +### -EnableNoAgentSharedVoicemailTranscription +The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentActionTarget -The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a GUID or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a Microsoft 365 Group ID. Otherwise, this field is optional. +### -EnableOverflowSharedVoicemailSystemPromptSuppression +The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. - -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low - -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +### -EnableOverflowSharedVoicemailTranscription +The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: Int16 +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -RoutingMethod -The RoutingMethod parameter defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If the routing method is set to RoundRobin, the agents will be called using the Round Robin strategy so that all agents share the call load equally. If the routing method is set to LongestIdle, the agents will be called based on their idle time, that is, the agent that has been idle for the longest period will be called. - -PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle +### -EnableTimeoutSharedVoicemailSystemPromptSuppression +The EnableTimeoutSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: Attendant +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PresenceBasedRouting -The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. +### -EnableTimeoutSharedVoicemailTranscription +The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. ```yaml Type: Boolean @@ -472,39 +436,37 @@ applicable: Microsoft Teams Required: False Position: Named -Default value: True +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ConferenceMode -The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: - -- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. +### -HideAuthorizedUsers +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. +This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml -Type: Boolean +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Users -The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). +### -IsCallbackEnabled + +The IsCallbackEnabled parameter is used to turn on/off callback. ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -547,11 +509,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OboResourceAccountIds -The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. +### -MusicOnHoldAudioFileId +The MusicOnHoldAudioFileId parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. ```yaml -Type: List +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -563,8 +525,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectTextToSpeechPrompt -The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. +### -Name +The Name parameter specifies a unique name for the Call Queue. ```yaml Type: String @@ -572,36 +534,48 @@ Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectAudioFilePrompt -The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. - +### -NoAgentAction +The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. + +PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail + ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ -The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. +If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -613,13 +587,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. +### -NoAgentActionTarget +The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a GUID or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a Microsoft 365 Group ID. Otherwise, this field is optional. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -631,24 +603,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppTextToSpeechPrompt -The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentApplyTo +The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. + +PARAMVALUE: AllCalls | NewCalls ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppAudioFilePrompt -The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentDisconnectAudioFilePrompt +The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. ```yaml Type: Guid @@ -663,8 +637,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberTextToSpeechPrompt -The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -NoAgentDisconnectTextToSpeechPrompt +The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. ```yaml Type: String @@ -679,8 +653,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberAudioFilePrompt -The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -NoAgentRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. ```yaml Type: Guid @@ -695,10 +671,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailTextToSpeechPrompt +### -NoAgentRedirectPersonTextToSpeechPrompt _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. +The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. ```yaml Type: String @@ -713,10 +689,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. +### -NoAgentRedirectPhoneNumberAudioFilePrompt +The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. ```yaml Type: Guid @@ -731,8 +705,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailTextToSpeechPrompt -The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. +### -NoAgentRedirectPhoneNumberTextToSpeechPrompt +The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. ```yaml Type: String @@ -747,8 +721,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailAudioFilePrompt -The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. +### -NoAgentRedirectVoiceAppAudioFilePrompt +The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml Type: Guid @@ -763,40 +737,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailTranscription -The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -NoAgentRedirectVoiceAppTextToSpeechPrompt +The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailSystemPromptSuppression -The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -NoAgentRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectTextToSpeechPrompt -The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. +### -NoAgentRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml Type: String @@ -811,8 +789,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectAudioFilePrompt -The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. +### -NoAgentSharedVoicemailAudioFilePrompt +The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid @@ -827,10 +805,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. +### -NoAgentSharedVoicemailTextToSpeechPrompt +The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. ```yaml Type: String @@ -845,16 +821,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NumberOfCallsInQueueBeforeOfferingCallback -The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. +The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -863,11 +839,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppTextToSpeechPrompt -The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. +### -OboResourceAccountIds +The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -879,43 +855,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppAudioFilePrompt -The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. +### -OverflowAction +The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. + +PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: DisconnectWithBusy Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberTextToSpeechPrompt -The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +If the OverFlowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low -### -TimeoutRedirectPhoneNumberAudioFilePrompt -The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -927,10 +901,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. +### -OverflowActionTarget +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. ```yaml Type: String @@ -945,10 +917,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. +### -OverflowDisconnectAudioFilePrompt +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. ```yaml Type: Guid @@ -963,8 +933,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailTextToSpeechPrompt -The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. +### -OverflowDisconnectTextToSpeechPrompt +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. ```yaml Type: String @@ -979,8 +949,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailAudioFilePrompt -The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. +### -OverflowRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml Type: Guid @@ -995,40 +967,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailTranscription -The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. +### -OverflowRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailSystemPromptSuppression -The EnableTimeoutSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -OverflowRedirectPhoneNumberAudioFilePrompt +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectTextToSpeechPrompt -The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. +### -OverflowRedirectPhoneNumberTextToSpeechPrompt +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml Type: String @@ -1043,8 +1017,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectAudioFilePrompt -The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. +### -OverflowRedirectVoiceAppAudioFilePrompt +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: Guid @@ -1059,10 +1033,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. +### -OverflowRedirectVoiceAppTextToSpeechPrompt +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: String @@ -1077,10 +1049,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonAudioFilePrompt +### -OverflowRedirectVoicemailAudioFilePrompt _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: Guid @@ -1095,8 +1067,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppTextToSpeechPrompt -The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. +### -OverflowRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: String @@ -1111,8 +1085,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppAudioFilePrompt -The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. +### -OverflowSharedVoicemailAudioFilePrompt +The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid @@ -1127,8 +1101,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberTextToSpeechPrompt -The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -OverflowSharedVoicemailTextToSpeechPrompt +The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. ```yaml Type: String @@ -1143,66 +1117,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberAudioFilePrompt -The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -OverflowThreshold +The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: 50 Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. +### -PresenceBasedRouting +The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -RoutingMethod +The RoutingMethod parameter defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If the routing method is set to RoundRobin, the agents will be called using the Round Robin strategy so that all agents share the call load equally. If the routing method is set to LongestIdle, the agents will be called based on their idle time, that is, the agent that has been idle for the longest period will be called. -The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. +PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Attendant Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailTextToSpeechPrompt -The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. +### -ServiceLevelThresholdResponseTimeInSecond + +The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. + +A value of `$null` indicates that a service level percentage will not be calculated for this call queue. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1211,14 +1185,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailAudioFilePrompt -The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. +### -SharedCallQueueHistoryTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1227,56 +1204,64 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailTranscription -The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -ShiftsSchedulingGroupId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Scheduling Group to connect a call queue to. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailSystemPromptSuppression -The EnableNoAgentSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -ShiftsTeamId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Team containing the Scheduling Group to connect a call queue to. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelId -Id of the channel to connect a call queue to. +### -ShouldOverwriteCallableChannelProperty + +A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelUserObjectId -Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team the channels belongs to. +### -Tenant +This parameter is reserved for Microsoft internal use only. ```yaml Type: Guid @@ -1291,12 +1276,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShiftsTeamId +### -TextAnnouncementForCR _Voice applications private preview customers only._ _Saving a call queue configuration through Teams admin center will *remove* this setting._ -Id of the Team containing the Scheduling Group to connect a call queue to. +The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. ```yaml Type: String @@ -1311,12 +1296,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShiftsSchedulingGroupId +### -TextAnnouncementForCRFailure _Voice applications private preview customers only._ _Saving a call queue configuration through Teams admin center will *remove* this setting._ -Id of the Scheduling Group to connect a call queue to. +The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. ```yaml Type: String @@ -1331,29 +1316,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthorizedUsers -This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +### -TimeoutAction +The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. + +PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail ```yaml -Type: List +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -HideAuthorizedUsers -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -TimeoutActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ -This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: List +Type: Int16 Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -1365,13 +1362,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeTextToSpeechPrompt -This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. +### -TimeoutActionTarget +The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. ```yaml Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1380,14 +1378,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsCallbackEnabled - -The IsCallbackEnabled parameter is used to turn on/off callback. +### -TimeoutDisconnectAudioFilePrompt +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1396,20 +1394,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackRequestDtmf - -The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: - -- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. -- ToneStar - Corresponds to DTMF tone *. -- TonePound - Corresponds to DTMF tone #. - -This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. +### -TimeoutDisconnectTextToSpeechPrompt +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. ```yaml Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1418,16 +1410,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WaitTimeBeforeOfferingCallbackInSecond - -The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. +### -TimeoutRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1436,16 +1428,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberOfCallsInQueueBeforeOfferingCallback - -The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. +### -TimeoutRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1454,16 +1446,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallToAgentRatioThresholdBeforeOfferingCallback +### -TimeoutRedirectPhoneNumberAudioFilePrompt +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. -The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Minimum value of 1. Set to null ($null) to disable this condition. +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt +The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1472,9 +1478,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferAudioFilePromptResourceId - -The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. +### -TimeoutRedirectVoiceAppAudioFilePrompt +The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. ```yaml Type: Guid @@ -1489,9 +1494,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferTextToSpeechPrompt - -The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. +### -TimeoutRedirectVoiceAppTextToSpeechPrompt +The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. ```yaml Type: String @@ -1506,9 +1510,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackEmailNotificationTarget +### -TimeoutRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. +The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. ```yaml Type: Guid @@ -1523,16 +1528,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceLevelThresholdResponseTimeInSecond - -The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. +### -TimeoutRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -A value of `$null` indicates that a service level percentage will not be calculated for this call queue. +The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1541,17 +1546,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingForCallQueueTemplateId -_Voice applications private preview customers only._ - -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. +### -TimeoutSharedVoicemailAudioFilePrompt +The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. ```yaml -Type: List +Type: Guid Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1560,12 +1562,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextAnnouncementForCR -_Voice applications private preview customers only._ - -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. +### -TimeoutSharedVoicemailTextToSpeechPrompt +The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. ```yaml Type: String @@ -1580,15 +1578,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomAudioFileAnnouncementForCR -_Voice applications private preview customers only._ +### -TimeoutThreshold +The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. +The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams -The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. +Required: False +Position: Named +Default value: 1200 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDefaultMusicOnHold +The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -1600,15 +1611,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextAnnouncementForCRFailure -_Voice applications private preview customers only._ - -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. +### -Users +The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -1620,18 +1627,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomAudioFileAnnouncementForCRFailure -_Voice applications private preview customers only._ +### -WaitTimeBeforeOfferingCallbackInSecond -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. -The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1640,17 +1645,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharedCallQueueHistoryTemplateId -_Voice applications private preview customers only._ - -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. +### -WelcomeMusicAudioFileId +The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1659,18 +1661,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShouldOverwriteCallableChannelProperty - -A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. +### -WelcomeTextToSpeechPrompt +This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/New-CsCallingLineIdentity.md similarity index 99% rename from teams/teams-ps/teams/New-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/New-CsCallingLineIdentity.md index 93e83c74a1..4777c1c4cb 100644 --- a/teams/teams-ps/teams/New-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity applicable: Microsoft Teams -title: New-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity +schema: 2.0.0 +title: New-CsCallingLineIdentity --- # New-CsCallingLineIdentity @@ -63,22 +64,6 @@ This example creates a new Caller ID policy that allows Teams users to make anon ## PARAMETERS -### -Identity -The Identity parameter identifies the Caller ID policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -BlockIncomingPstnCallerID The BlockIncomingPstnCallerID switch determines whether to block the incoming Caller ID. The default value is false. @@ -129,6 +114,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description The Description parameter briefly describes the Caller ID policy. @@ -165,8 +166,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceAccount -This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts +### -Identity +The Identity parameter identifies the Caller ID policy. ```yaml Type: String @@ -174,20 +175,20 @@ Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +### -ResourceAccount +This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: applicable: Microsoft Teams Required: False @@ -197,13 +198,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -WhatIf +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi applicable: Microsoft Teams Required: False diff --git a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md b/teams/teams-ps/MicrosoftTeams/New-CsCloudCallDataConnection.md similarity index 99% rename from teams/teams-ps/teams/New-CsCloudCallDataConnection.md rename to teams/teams-ps/MicrosoftTeams/New-CsCloudCallDataConnection.md index 772f8f1d49..30f6a9efcf 100644 --- a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCloudCallDataConnection.md @@ -1,15 +1,15 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: New-CsCloudCallDataConnection -online version: https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection -schema: 2.0.0 author: 2012ucp1544 +external help file: MicrosoftTeams-help.xml +Locale: en-US +manager: subadjat +Module Name: MicrosoftTeams ms.author: uditagrawal ms.reviewer: pbafna -manager: subadjat - +online version: https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection +schema: 2.0.0 +title: New-CsCloudCallDataConnection --- # New-CsCloudCallDataConnection diff --git a/teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsComplianceRecordingForCallQueueTemplate.md similarity index 92% rename from teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsComplianceRecordingForCallQueueTemplate.md index f98067448d..d4ef312e41 100644 --- a/teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsComplianceRecordingForCallQueueTemplate.md @@ -1,21 +1,27 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/New-CsComplianceRecordingForCallQueueTemplate applicable: Microsoft Teams -title: New-CsComplianceRecordingForCallQueueTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/New-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: New-CsComplianceRecordingForCallQueueTemplate --- # New-CsComplianceRecordingForCallQueueTemplate +## SYNOPSIS +Use the New-CsComplianceRecordingForCallQueueTemplate cmdlet to create a Compliance Recording for Call Queues template. + ## SYNTAX -```powershell -New-CsComplianceRecordingForCallQueueTemplate -Name -Description -BotId [-RequiredDuringCall ] [-RequiredBeforeCall ] [-CurrentInvitationCount ] [-PairedApplication ] [] +``` +New-CsComplianceRecordingForCallQueueTemplate -Name -Description -BotId + [-RequiredDuringCall ] [-RequiredBeforeCall ] [-CurrentInvitationCount ] + [-PairedApplication ] [] ``` ## DESCRIPTION @@ -26,7 +32,7 @@ Use the New-CsComplianceRecordingForCallQueueTemplate cmdlet to create a Complia ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsComplianceRecordingForCallQueueTemplate -Name "Customer Service" -Description "Required before/during call" -BotId 14732826-8206-42e3-b51e-6693e2abb698 -RequiredDuringCall $true -RequiredBeforeCall $true ``` @@ -35,8 +41,8 @@ This example creates a new Compliance Recording for Call Queue template. ## PARAMETERS -### -Name -The name of the compliance recording for call queue template. +### -BotId +The Id of the compliance recording for call queue bot to invite. ```yaml Type: System.String @@ -51,24 +57,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description for the compliance recording for call queues template. +### -ConcurrentInvitationCount +The number of concurrent invitations to send to the compliance recording for call queue bot. ```yaml -Type: System.String +Type: System.Int32 Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: 1 Accept pipeline input: False Accept wildcard characters: False ``` -### -BotId -The Id of the compliance recording for call queue bot to invite. +### -Description +A description for the compliance recording for call queues template. ```yaml Type: System.String @@ -83,68 +89,68 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredDuringCall -Indicates if the compliance recording for call queues bot must remain part of the call. -*Strict recording* - if the bot leaves the call, the call will end. +### -Name +The name of the compliance recording for call queue template. ```yaml -Type: System.Booleen +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredBeforeCall -Indicates if the compliance recording for call queues bot must be able to join the call. -*Strict recording* - if the bot can't join the call, the call will end. +### -PairedApplication +The PairedApplication parameter specifies the paired application for the call queue. ```yaml -Type: System.Booleen +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentInvitationCount -The number of concurrent invitations to send to the compliance recording for call queue bot. +### -RequiredBeforeCall +Indicates if the compliance recording for call queues bot must be able to join the call. +*Strict recording* - if the bot can't join the call, the call will end. ```yaml -Type: System.Int32 +Type: System.Booleen Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: 1 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PairedApplication -The PairedApplication parameter specifies the paired application for the call queue. +### -RequiredDuringCall +Indicates if the compliance recording for call queues bot must remain part of the call. +*Strict recording* - if the bot leaves the call, the call will end. ```yaml -Type: System.String +Type: System.Booleen Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -177,6 +183,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsCallQueue](./Set-CsCallQueue.md) [Remove-CsCallQueue](./Remove-CsCallQueue.md) - - - diff --git a/teams/teams-ps/teams/New-CsCustomPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/New-CsCustomPolicyPackage.md similarity index 97% rename from teams/teams-ps/teams/New-CsCustomPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/New-CsCustomPolicyPackage.md index bf6a5dfc6b..317b7742cb 100644 --- a/teams/teams-ps/teams/New-CsCustomPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsCustomPolicyPackage.md @@ -1,20 +1,18 @@ --- +author: sunguchuan external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: New-CsCustomPolicyPackage -author: sunguchuan ms.author: gucsun -manager: dasosby online version: https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage schema: 2.0.0 +title: New-CsCustomPolicyPackage --- # New-CsCustomPolicyPackage ## SYNOPSIS - -**Note:** This cmdlet is currently in private preview. - This cmdlet creates a custom policy package. ## SYNTAX @@ -27,6 +25,8 @@ New-CsCustomPolicyPackage -Identity -PolicyList [-Descriptio This cmdlet creates a custom policy package. It allows the admin to create their own policy packages for the tenant. For more information on policy packages and the policy types available, see [Managing policy packages in Teams](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages). +**Note:** This cmdlet is currently in private preview. + ## EXAMPLES ### Example 1 @@ -44,49 +44,52 @@ Creates a custom package named "MyPackage" with description "My package" and two ## PARAMETERS -### -Identity +### -Description -The name of the custom package. +> Applicable: Microsoft Teams + +The description of the custom package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True -Position: 0 +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyList +### -Identity -A list of one or more policies to be added in the package. To specify the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy). +> Applicable: Microsoft Teams + +The name of the custom package. ```yaml -Type: String[] +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -PolicyList -The description of the custom package. +> Applicable: Microsoft Teams + +A list of one or more policies to be added in the package. To specify the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy). ```yaml -Type: String +Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains.md similarity index 98% rename from teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md rename to teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains.md index 2aef1fe8ea..1efe6cfcd8 100644 --- a/teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowAllKnownDomains.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csedgeallowallknowndomains applicable: Microsoft Teams -title: New-CsEdgeAllowAllKnownDomains -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csedgeallowallknowndomains +schema: 2.0.0 +title: New-CsEdgeAllowAllKnownDomains --- # New-CsEdgeAllowAllKnownDomains @@ -51,7 +53,7 @@ To configure federation with all known domains, use a set of commands similar to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsEdgeAllowAllKnownDomains diff --git a/teams/teams-ps/teams/New-CsEdgeAllowList.md b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowList.md similarity index 97% rename from teams/teams-ps/teams/New-CsEdgeAllowList.md rename to teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowList.md index 051c806683..cb0506c52c 100644 --- a/teams/teams-ps/teams/New-CsEdgeAllowList.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsEdgeAllowList.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csedgeallowlist applicable: Microsoft Teams -title: New-CsEdgeAllowList -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csedgeallowlist +schema: 2.0.0 +title: New-CsEdgeAllowList --- # New-CsEdgeAllowList ## SYNOPSIS Enables administrators to specify the domains that their users will be allowed to communicate with. -The `New-CsEdgeAllowList` cmdlet, which can be used only with Skype for Business Online, must be used in conjunction with the `New-CsEdgeDomainPattern` cmdlet and the `Set-CsTenantFederationConfiguration` cmdlet. ## SYNTAX @@ -23,6 +24,8 @@ New-CsEdgeAllowList [-AllowedDomain ] [] ``` ## DESCRIPTION +The `New-CsEdgeAllowList` cmdlet, which can be used only with Skype for Business Online, must be used in conjunction with the `New-CsEdgeDomainPattern` cmdlet and the `Set-CsTenantFederationConfiguration` cmdlet. + Federation is a service that enables users to exchange IM and presence information with users from other domains. With Skype for Business Online, administrators can use the federation configuration settings to govern: @@ -56,7 +59,7 @@ When this command finishes executing, users will only be allowed to communicate ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -72,7 +75,7 @@ After the domain object has been created, the `New-CsEdgeAllowList` cmdlet is us With the allowed domain list created, the final command in the example can then use the `Set-CsTenantFederationConfiguration` cmdlet to configure fabrikam.com as the only domain on the allowed domain list for the current tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = New-CsEdgeDomainPattern -Domain "contoso.com" @@ -87,7 +90,7 @@ Example 2 shows how you can add multiple domains to an allowed domains list. This is done by calling the `New-CsEdgeDomainPattern` cmdlet multiple times (one for each domain to be added to the list), and storing the resulting domain objects in separate variables. Each of those variables can then be added to the allow list created by the `New-CsEdgeAllowList` cmdlet simply by using the AllowedDomain parameter and separating the variables name by using commas. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $newAllowList = New-CsEdgeAllowList -AllowedDomain $Null diff --git a/teams/teams-ps/teams/New-CsEdgeDomainPattern.md b/teams/teams-ps/MicrosoftTeams/New-CsEdgeDomainPattern.md similarity index 98% rename from teams/teams-ps/teams/New-CsEdgeDomainPattern.md rename to teams/teams-ps/MicrosoftTeams/New-CsEdgeDomainPattern.md index 5bc669bc16..c6c5e9388b 100644 --- a/teams/teams-ps/teams/New-CsEdgeDomainPattern.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsEdgeDomainPattern.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csedgedomainpattern applicable: Microsoft Teams -title: New-CsEdgeDomainPattern -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csedgedomainpattern +schema: 2.0.0 +title: New-CsEdgeDomainPattern --- # New-CsEdgeDomainPattern ## SYNOPSIS Used to specify a domain that will be added or removed from the set of domains enabled for federation or the set of domains disabled for federation. -You must use the New-CsEdgeDomainPattern cmdlet when modifying the allowed or blocked domain lists. -String values (such as "fabrikam.com") cannot be directly passed to the cmdlets used to manage either of these lists. ## SYNTAX @@ -24,6 +24,9 @@ New-CsEdgeDomainPattern -Domain [] ``` ## DESCRIPTION +You must use the New-CsEdgeDomainPattern cmdlet when modifying the allowed or blocked domain lists. +String values (such as "fabrikam.com") cannot be directly passed to the cmdlets used to manage either of these lists. + Federation is a service that enables users to exchange IM and presence information with users from other domains. With Skype for Business Online, administrators can use the federation configuration settings to govern: @@ -48,7 +51,7 @@ Instead, you must create a domain object by using the New-CsEdgeDomainPattern cm ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" diff --git a/teams/teams-ps/teams/New-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsExternalAccessPolicy.md similarity index 93% rename from teams/teams-ps/teams/New-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsExternalAccessPolicy.md index 78f3038720..549e36f100 100644 --- a/teams/teams-ps/teams/New-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsExternalAccessPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy applicable: Microsoft Teams -title: New-CsExternalAccessPolicy -schema: 2.0.0 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy +schema: 2.0.0 +title: New-CsExternalAccessPolicy --- # New-CsExternalAccessPolicy @@ -15,12 +17,6 @@ ms.reviewer: rogupta Enables you to create a new external access policy. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. - -This cmdlet was introduced in Lync Server 2010. - -For information about external access in Microsoft Teams, see [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) and [Teams and Skype interoperability](https://learn.microsoft.com/microsoftteams/teams-skype-interop) for specific details. - ## SYNTAX ```powershell @@ -49,6 +45,9 @@ New-CsExternalAccessPolicy [-Identity] ## DESCRIPTION +This cmdlet was introduced in Lync Server 2010. + +For information about external access in Microsoft Teams, see [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) and [Teams and Skype interoperability](https://learn.microsoft.com/microsoftteams/teams-skype-interop) for specific details. When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. @@ -83,7 +82,7 @@ The following parameters are not applicable to Skype for Business Online/Microso ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True -EnableOutsideAccess $True ``` @@ -91,7 +90,7 @@ New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True The command shown in Example 1 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. Note that this new policy sets both the EnableFederationAccess and the EnableOutsideAccess properties to True. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false @@ -99,7 +98,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederatio In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $True -EnableTeamsConsumerInbound $False ``` @@ -107,7 +106,7 @@ New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $Tr The command shown in Example 3 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. Note that this new policy enables communication with people using Teams with an account that's not managed by an organization and limits this to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people with this policy assigned. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` $x = New-CsExternalAccessPolicy -Identity RedmondAccessPolicy -InMemory @@ -127,7 +126,7 @@ Finally, the last command uses the Set-CsExternalAccessPolicy cmdlet to create a If you do not call the Set-CsExternalAccessPolicy cmdlet, then the virtual policy will disappear as soon as you end your Windows PowerShell session or delete the variable $x. Should that happen, an external access policy with the Identity RedmondAccessPolicy will never be created. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWithExternalOrgs "AllowSpecificExternalDomains" -AllowedExternalDomains @("example1.com", "example2.com") Set-CsTenantFederationConfiguration -CustomizeFederation $true @@ -137,32 +136,10 @@ In this example, we create an ExternalAccessPolicy named "GranularFederationExam ## PARAMETERS -### -Identity -Unique Identity to be assigned to the policy. New external access policies can be created at the site or per-user scope. - -To create a new site policy, use the prefix "site:" and the name of the site as your Identity. - -For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.` - -To create a new per-user policy, use an Identity similar to this: `-Identity SalesAccessPolicy.` +### -AllowedExternalDomains -Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsExternalAccessPolicy cmdlet instead. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. If you need to make changes to an existing policy, use the Set-CsExternalAccessPolicy cmdlet. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedExternalDomains > [!NOTE] > Please note that this parameter is in Private Preview. @@ -172,7 +149,6 @@ Specifies the external domains allowed to communicate with users assigned to thi Type: List Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -181,6 +157,9 @@ Accept wildcard characters: False ``` ### -BlockedExternalDomains + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + > [!NOTE] > Please note that this parameter is in Private Preview. @@ -190,7 +169,6 @@ Specifies the external domains blocked from communicating with users assigned to Type: List Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -199,6 +177,9 @@ Accept wildcard characters: False ``` ### -CommunicationWithExternalOrgs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + > [!NOTE] > Please note that this parameter is in Private Preview. @@ -215,7 +196,6 @@ The setting is only applicable when `EnableFederationAccess` is set to true. Thi Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named Default value: OrganizationDefault @@ -255,6 +235,9 @@ Accept wildcard characters: False ``` ### -EnableAcsFederationAccess + +> Applicable: Microsoft Teams + Indicates whether Teams meetings organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. @@ -265,7 +248,6 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -396,12 +378,12 @@ Accept wildcard characters: False ### -FederatedBilateralChats This setting enables bi-lateral chats for the users included in the messaging policy. -Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. - -Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. - +Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. + +Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. + Users with bilateral policy applied are also removed from existing external group chats with more than two organizations. - + This policy doesn't apply to meetings, meeting chats, or channels. ```yaml @@ -431,6 +413,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique Identity to be assigned to the policy. New external access policies can be created at the site or per-user scope. + +To create a new site policy, use the prefix "site:" and the name of the site as your Identity. + +For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.` + +To create a new per-user policy, use an Identity similar to this: `-Identity SalesAccessPolicy.` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsExternalAccessPolicy cmdlet instead. + +Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. If you need to make changes to an existing policy, use the Set-CsExternalAccessPolicy cmdlet. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. diff --git a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/New-CsGroupPolicyAssignment.md similarity index 99% rename from teams/teams-ps/teams/New-CsGroupPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/New-CsGroupPolicyAssignment.md index efbf01984f..a50608fd7f 100644 --- a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsGroupPolicyAssignment.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment -title: New-CsGroupPolicyAssignment -schema: 2.0.0 -author: tomkau ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment +schema: 2.0.0 +title: New-CsGroupPolicyAssignment --- # New-CsGroupPolicyAssignment @@ -99,6 +100,21 @@ e050ce51-54bc-45b7-b3e6-c00343d31274 TeamsMeetingPolicy AllOff 2 11/2/201 ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GroupId The ID of a batch policy assignment operation. @@ -114,17 +130,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -The type of policy to be assigned. +### -PassThru +Returns true when the command succeeds ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -144,32 +160,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -PolicyType +The type of policy to be assigned. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns true when the command succeeds +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -190,21 +206,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/New-CsHybridTelephoneNumber.md similarity index 90% rename from teams/teams-ps/teams/New-CsHybridTelephoneNumber.md rename to teams/teams-ps/MicrosoftTeams/New-CsHybridTelephoneNumber.md index 80fbe8f586..a1aaba57f9 100644 --- a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsHybridTelephoneNumber.md @@ -1,105 +1,107 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber -applicable: Microsoft Teams -title: New-CsHybridTelephoneNumber -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# New-CsHybridTelephoneNumber - -## SYNOPSIS -This cmdlet adds a hybrid telephone number to the tenant. - -> [!IMPORTANT] -> This cmdlet is being deprecated. Use the **New-CsOnlineDirectRoutingTelephoneNumberUploadOrder** cmdlet to add a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder?view=teams-ps) - -## SYNTAX - -### Identity (Default) -```powershell -New-CsHybridTelephoneNumber -TelephoneNumber [-Force] -InputObject [] -``` - -## DESCRIPTION -This cmdlet adds a hybrid telephone number to the tenant that can be used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - -## EXAMPLES - -### Example 1 -```powershell -New-CsHybridTelephoneNumber -TelephoneNumber +14025551234 -``` -This example adds the hybrid phone number +1 (402) 555-1234. - -## PARAMETERS - -### -TelephoneNumber -The telephone number to add. The number should be specified with a prefixed "+". The phone number can't have "tel:" prefixed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The identity parameter. - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: NewViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -The cmdlet is only available in GCC High and DoD cloud instances. - -## RELATED LINKS -[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber) - -[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber +schema: 2.0.0 +title: New-CsHybridTelephoneNumber +--- + +# New-CsHybridTelephoneNumber + +## SYNOPSIS +This cmdlet adds a hybrid telephone number to the tenant. + +## SYNTAX + +### Identity (Default) + +``` +New-CsHybridTelephoneNumber -TelephoneNumber [-Force] -InputObject [] +``` + +## DESCRIPTION +This cmdlet adds a hybrid telephone number to the tenant that can be used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the **New-CsOnlineDirectRoutingTelephoneNumberUploadOrder** cmdlet to add a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md). + +## EXAMPLES + +### Example 1 +```powershell +New-CsHybridTelephoneNumber -TelephoneNumber +14025551234 +``` +This example adds the hybrid phone number +1 (402) 555-1234. + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: NewViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TelephoneNumber + +> Applicable: Microsoft Teams + +The telephone number to add. The number should be specified with a prefixed "+". The phone number can't have "tel:" prefixed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### None + +## NOTES + +The cmdlet is only available in GCC High and DoD cloud instances. + +## RELATED LINKS +[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber) + +[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber) diff --git a/teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/New-CsInboundBlockedNumberPattern.md similarity index 98% rename from teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/New-CsInboundBlockedNumberPattern.md index ba2c63af2f..22c24bcf0f 100644 --- a/teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern applicable: Microsoft Teams -title: New-CsInboundBlockedNumberPattern author: serdarsoysal -ms.author: serdars -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern schema: 2.0.0 +title: New-CsInboundBlockedNumberPattern --- # New-CsInboundBlockedNumberPattern @@ -43,6 +44,21 @@ This example adds a blocked number pattern to block inbound calls from +11234567 ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description A friendly description for the blocked number pattern to be created. @@ -134,21 +150,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/New-CsInboundExemptNumberPattern.md similarity index 91% rename from teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/New-CsInboundExemptNumberPattern.md index 63ed383946..496515413d 100644 --- a/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern applicable: Microsoft Teams -title: New-CsInboundExemptNumberPattern -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern +schema: 2.0.0 +title: New-CsInboundExemptNumberPattern --- # New-CsInboundExemptNumberPattern @@ -20,7 +20,7 @@ This cmdlet lets you configure a new number pattern that is exempt from tenant c ### Identity (Default) -```powershell +``` New-CsInboundExemptNumberPattern -Identity -Pattern [-Description ] [-Enabled ] [-WhatIf] [-Confirm] [] ``` @@ -30,6 +30,8 @@ New-CsInboundExemptNumberPattern -Identity -Pattern [-Descript New-CsInboundExemptNumberPattern -Pattern -Name [-Description ] [-Enabled ] [-WhatIf] [-Confirm] [] ``` +## DESCRIPTION +The `New-CsInboundExemptNumberPattern` cmdlet creates a new inbound exempt number pattern that allows specific phone numbers to bypass tenant call blocking. This is useful for ensuring that important numbers, such as emergency services or critical business contacts, are not inadvertently blocked by the tenant's call blocking policies. ## EXAMPLES @@ -43,6 +45,22 @@ Creates a new inbound exempt number pattern for the numbers 1 (312) 555-88882 an ## PARAMETERS +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Sets the description of the number pattern. @@ -136,22 +154,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstance.md similarity index 94% rename from teams/teams-ps/teams/New-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstance.md index 0254f15626..426c6ca514 100644 --- a/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance applicable: Microsoft Teams -title: New-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance +schema: 2.0.0 +title: New-CsOnlineApplicationInstance --- # New-CsOnlineApplicationInstance @@ -26,7 +27,7 @@ This cmdlet is used to create an application instance in Microsoft Entra ID. Thi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell New-CsOnlineApplicationInstance -UserPrincipalName appinstance01@contoso.com -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" ``` @@ -35,46 +36,52 @@ This example creates a new application instance for an Auto Attendant with UserP ## PARAMETERS -### -UserPrincipalName -The user principal name. It will be used as the SIP URI too. The user principal name should have an online domain. +### -ApplicationId + +> Applicable: Microsoft Teams + +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml -Type: System.String +Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Microsoft Teams + The display name. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -84,13 +91,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -99,31 +108,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -UserPrincipalName + +> Applicable: Microsoft Teams + +The user principal name. It will be used as the SIP URI too. The user principal name should have an online domain. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation.md similarity index 97% rename from teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation.md index 9cc704f634..a173fe1373 100644 --- a/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation applicable: Microsoft Teams -title: New-CsOnlineApplicationInstanceAssociation -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation +schema: 2.0.0 +title: New-CsOnlineApplicationInstanceAssociation --- # New-CsOnlineApplicationInstanceAssociation @@ -28,7 +30,7 @@ You can get the Identity of the application instance from the ObjectId of the AD ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $applicationInstanceId = (Get-CsOnlineUser "main_auto_attendant@contoso.com").ObjectId # 76afc66a-5fe9-4a3d-ab7a-37c0e37b1f19 $autoAttendantId = (Get-CsAutoAttendant -NameFilter "Main Auto Attendant").Id # c2ee3e18-b738-5515-a97b-46be52dfc057 @@ -57,7 +59,7 @@ Get-CsAutoAttendant -Identity $autoAttendantId This example creates an association between an application instance that we have already created with UPN "main_auto_attendant@contoso.com" whose identity is "76afc66a-5fe9-4a3d-ab7a-37c0e37b1f19", and an auto attendant configuration that we created with display name "Main Auto Attendant" whose identity is "c2ee3e18-b738-5515-a97b-46be52dfc057". Once the association is created, the newly associated application instance would be listed under the `ApplicationInstances` property of the AA. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $applicationInstancesIdentities = (Find-CsOnlineApplicationInstance -SearchQuery "tel:+1206") | Select-Object -Property Id @@ -93,7 +95,7 @@ Get-CsAutoAttendant -Identity $autoAttendantId This example creates an association between multiple application instances that we had created before and to which we assigned phone numbers starting with "tel:+1206", and an auto attendant configuration that we created with display name "Main Auto Attendant" whose identity is "c2ee3e18-b738-5515-a97b-46be52dfc057". Once the associations are created, the newly associated application instances would listed under the `ApplicationInstances` property of the AA. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $applicationInstancesIdentities = (Find-CsOnlineApplicationInstance -SearchQuery "Main Auto Attendant") | Select-Object -Property Id @@ -112,18 +114,26 @@ This example creates an association between multiple application instances that ## PARAMETERS -### -Identities -The Identities parameter is the identities of application instances to be associated with the provided configuration ID. +### -CallPriority +The call priority assigned to calls arriving on this application instance if a priority has not already been assigned. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 + +1 = Very High +2 = High +3 = Normal / Default +4 = Low +5 = Very Low ```yaml -Type: System.String[] +Type: Int16 Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: 3 Accept pipeline input: False Accept wildcard characters: False ``` @@ -165,26 +175,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallPriority -The call priority assigned to calls arriving on this application instance if a priority has not already been assigned. - -PARAMVALUE: 1 | 2 | 3 | 4 | 5 - -1 = Very High -2 = High -3 = Normal / Default -4 = Low -5 = Very Low +### -Identities +The Identities parameter is the identities of application instances to be associated with the provided configuration ID. ```yaml -Type: Int16 +Type: System.String[] Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: 3 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineAudioConferencingRoutingPolicy.md similarity index 96% rename from teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineAudioConferencingRoutingPolicy.md index f38c088398..f2672d61ac 100644 --- a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,177 +1,178 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy -title: New-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# New-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet creates a Online Audio Conferencing Routing Policy. - -## SYNTAX - -```powershell -New-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-Description ] - [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. - -To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." - -The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. - -Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-CsOnlineAudioConferencingRoutingPolicy -Identity Test -``` - -Creates a new Online Audio Conferencing Routing Policy policy with an identity called "Test". - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Identity of the Online Audio Conferencing Routing Policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnlinePstnUsages - -A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteType - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) -[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) -[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) -[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: New-CsOnlineAudioConferencingRoutingPolicy +--- + +# New-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet creates a Online Audio Conferencing Routing Policy. + +## SYNTAX + +```powershell +New-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-Description ] + [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsOnlineAudioConferencingRoutingPolicy -Identity Test +``` + +Creates a new Online Audio Conferencing Routing Policy policy with an identity called "Test". + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnUsages + +A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/New-CsOnlineDateTimeRange.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDateTimeRange.md similarity index 98% rename from teams/teams-ps/teams/New-CsOnlineDateTimeRange.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineDateTimeRange.md index ad73e8f554..483591e6f6 100644 --- a/teams/teams-ps/teams/New-CsOnlineDateTimeRange.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDateTimeRange.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange applicable: Microsoft Teams -title: New-CsOnlineDateTimeRange -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange +schema: 2.0.0 +title: New-CsOnlineDateTimeRange --- # New-CsOnlineDateTimeRange @@ -50,8 +52,10 @@ This example creates a date-time range spanning from December 24, 2017 9AM to De ## PARAMETERS -### -Start -The Start parameter represents the start bound of the date-time range. +### -End +The End parameter represents the end bound of the date-time range. + +If not present, the end bound of the date time range is set to 00:00 of the day after the start date. ```yaml Type: System.String @@ -59,17 +63,15 @@ Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -End -The End parameter represents the end bound of the date-time range. - -If not present, the end bound of the date time range is set to 00:00 of the day after the start date. +### -Start +The Start parameter represents the start bound of the date-time range. ```yaml Type: System.String @@ -77,7 +79,7 @@ Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md similarity index 93% rename from teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md index b7d52913b8..bec8e60abb 100644 --- a/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder applicable: Microsoft Teams -title: New-CsOnlineDirectRoutingTelephoneNumberUploadOrder author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder schema: 2.0.0 +title: New-CsOnlineDirectRoutingTelephoneNumberUploadOrder --- # New-CsOnlineDirectRoutingTelephoneNumberUploadOrder ## SYNOPSIS -This cmdlet creates a request to upload Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. The output of the cmdlet is the "orderId" of the asynchronous Direct Routing Number creation operation. A maximum of 10,000 phone numbers can be uploaded at a time. If more than 10,000 numbers need to be uploaded, the requests should be divided into multiple increments of up to 10,000 numbers. +This cmdlet creates a request to upload Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. ## SYNTAX @@ -23,7 +24,7 @@ New-CsOnlineDirectRoutingTelephoneNumberUploadOrder [-TelephoneNumber ] ``` ## DESCRIPTION -This cmdlet uploads Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. Once uploaded the phone numbers will be visible in Teams PowerShell as acquired Direct Routing phone numbers. +This cmdlet uploads Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. Once uploaded the phone numbers will be visible in Teams PowerShell as acquired Direct Routing phone numbers. The output of the cmdlet is the "orderId" of the asynchronous Direct Routing Number creation operation. A maximum of 10,000 phone numbers can be uploaded at a time. If more than 10,000 numbers need to be uploaded, the requests should be divided into multiple increments of up to 10,000 numbers. The cmdlet is an asynchronous operation and will return an OrderId as output. You can use the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to check the status of the OrderId, including any error or warning messages that might result from the operation: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. @@ -64,8 +65,8 @@ In this example, the content of a file with a list of Direct Routing telephone n ## PARAMETERS -### -TelephoneNumber -This is the Direct Routing telephone numbers you wish to upload to Microsoft Teams telephone number management inventory. It is comma delimited list of one or more Direct Routing telephone numbers. +### -EndingNumber +This is the ending number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. ```yaml Type: String @@ -79,11 +80,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartingNumber -This is the starting number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. +### -FileContent +This is the content of a .csv file that includes the Direct Routing telephone numbers to be uploaded to the Microsoft Teams telephone number management inventory. This parameter can be used to upload up to 10,000 numbers at a time. ```yaml -Type: String +Type: Byte[] Parameter Sets: (All) Aliases: @@ -94,8 +95,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EndingNumber -This is the ending number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. +### -StartingNumber +This is the starting number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. ```yaml Type: String @@ -109,11 +110,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileContent -This is the content of a .csv file that includes the Direct Routing telephone numbers to be uploaded to the Microsoft Teams telephone number management inventory. This parameter can be used to upload up to 10,000 numbers at a time. +### -TelephoneNumber +This is the Direct Routing telephone numbers you wish to upload to Microsoft Teams telephone number management inventory. It is comma delimited list of one or more Direct Routing telephone numbers. ```yaml -Type: Byte[] +Type: String Parameter Sets: (All) Aliases: @@ -142,4 +143,4 @@ The cmdlet is only available in commercial and GCC cloud instances. ## RELATED LINKS [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) -[New-CsOnlineTelephoneNumberReleaseOrder](./new-csonlinetelephonenumberreleaseorder.md) \ No newline at end of file +[New-CsOnlineTelephoneNumberReleaseOrder](./new-csonlinetelephonenumberreleaseorder.md) diff --git a/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisCivicAddress.md similarity index 99% rename from teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineLisCivicAddress.md index 18fa5f7f05..971b394dc5 100644 --- a/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisCivicAddress.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: New-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress +schema: 2.0.0 +title: New-CsOnlineLisCivicAddress --- # New-CsOnlineLisCivicAddress @@ -75,8 +75,8 @@ This example creates a new civic address described as "West Coast Headquarters": ## PARAMETERS -### -CompanyName -Specifies the name of your organization. +### -City +Specifies the city of the new civic address. ```yaml Type: String @@ -84,16 +84,15 @@ Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CountryOrRegion -Specifies the country or region of the new civic address. -Needs to be a valid country code as contained in the ISO 3166-1 alpha-2 specification. +### -CityAlias +Specifies the city alias of the new civic address. ```yaml Type: String @@ -101,15 +100,15 @@ Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -City -Specifies the city of the new civic address. +### -CompanyName +Specifies the name of your organization. ```yaml Type: String @@ -117,15 +116,15 @@ Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias -Specifies the city alias of the new civic address. +### -CompanyTaxId +Specifies the company tax identifier of the new civic address. ```yaml Type: String @@ -140,17 +139,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CompanyTaxId -Specifies the company tax identifier of the new civic address. +### -Confidence +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf applicable: Microsoft Teams Required: False Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryOrRegion +Specifies the country or region of the new civic address. +Needs to be a valid country code as contained in the ISO 3166-1 alpha-2 specification. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -240,6 +271,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsAzureMapValidationRequired +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Latitude Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. Required for all countries except Australia and Japan where it's optional. @@ -371,36 +417,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confidence -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsAzureMapValidationRequired -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ValidationStatus This parameter is reserved for internal Microsoft use. @@ -433,22 +449,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisLocation.md similarity index 92% rename from teams/teams-ps/teams/New-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineLisLocation.md index 418b3f5aa2..ba898a4e4d 100644 --- a/teams/teams-ps/teams/New-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation applicable: Microsoft Teams -title: New-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation +schema: 2.0.0 +title: New-CsOnlineLisLocation --- # New-CsOnlineLisLocation @@ -34,48 +35,56 @@ This example creates a new location called "Office 101, 1st Floor" in the civic ## PARAMETERS -### -CivicAddressId -Specifies the unique identifier of the civic address that will contain the new location. Civic address identities can be discovered by using the Get-CsOnlineLisCivicAddress cmdlet. +### -City + +> Applicable: Microsoft Teams + +Specifies the city of the civic address. + +**Note:** This parameter is not supported and is deprecated. ```yaml -Type: Guid -Parameter Sets: (All) +Type: String +Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -Location -Specifies an administrator-defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". +### -CityAlias + +> Applicable: Microsoft Teams + +Specifies the city alias. + +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -CountryOrRegion -Specifies the country or region of the civic address. +### -CivicAddressId -**Note:** This parameter is not supported and is deprecated. +> Applicable: Microsoft Teams + +Specifies the unique identifier of the civic address that will contain the new location. Civic address identities can be discovered by using the Get-CsOnlineLisCivicAddress cmdlet. ```yaml -Type: String -Parameter Sets: CreateCivicAddress -Aliases: Country -Applicable: Microsoft Teams +Type: Guid +Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -84,26 +93,31 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -City -Specifies the city of the civic address. +### -CompanyName + +> Applicable: Microsoft Teams + +Specifies the name of your organization. **Note:** This parameter is not supported and is deprecated. ```yaml Type: String -Parameter Sets: CreateCivicAddress -Aliases: -Applicable: Microsoft Teams +Parameter Sets: (All) +Aliases: Name Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias -Specifies the city alias. +### -CompanyTaxId + +> Applicable: Microsoft Teams + +The company tax ID. **Note:** This parameter is not supported and is deprecated. @@ -111,7 +125,6 @@ Specifies the city alias. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -120,16 +133,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -CompanyName -Specifies the name of your organization. +### -Confidence -**Note:** This parameter is not supported and is deprecated. +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: Name -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -138,41 +151,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CompanyTaxId -The company tax ID. +### -Confirm -**Note:** This parameter is not supported and is deprecated. +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named -Default value: None -Accept pipeline input: True +Default value: False +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confidence -This parameter is reserved for internal Microsoft use. +### -CountryOrRegion + +> Applicable: Microsoft Teams + +Specifies the country or region of the civic address. + +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Parameter Sets: CreateCivicAddress +Aliases: Country -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -181,7 +201,6 @@ Specifies an administrator defined description of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -191,13 +210,33 @@ Accept wildcard characters: False ``` ### -Elin + +> Applicable: Microsoft Teams + Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Microsoft Teams + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -207,6 +246,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Microsoft Teams + Specifies the numeric portion of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -215,7 +257,6 @@ Specifies the numeric portion of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -225,6 +266,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Microsoft Teams + Specifies the numeric suffix of the civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". @@ -234,7 +278,6 @@ For example, if the property was multiplexed, the HouseNumberSuffix parameter wo Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -244,6 +287,9 @@ Accept wildcard characters: False ``` ### -Latitude + +> Applicable: Microsoft Teams + Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. **Note:** This parameter is not supported and is deprecated. @@ -252,7 +298,6 @@ Specifies the angular distance of a place north or south of the earth's equator Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -261,7 +306,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Location + +> Applicable: Microsoft Teams + +Specifies an administrator-defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Longitude + +> Applicable: Microsoft Teams + Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. **Note:** This parameter is not supported and is deprecated. @@ -270,7 +336,6 @@ Specifies the angular distance of a place east or west of the meridian at Greenw Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -280,6 +345,9 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Microsoft Teams + Specifies the postal code of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -288,7 +356,6 @@ Specifies the postal code of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -298,6 +365,9 @@ Accept wildcard characters: False ``` ### -PostDirectional + +> Applicable: Microsoft Teams + Specifies the directional attribute of the civic address which follows the street name. For example, "425 Smith Avenue NE". **Note:** This parameter is not supported and is deprecated. @@ -306,7 +376,6 @@ Specifies the directional attribute of the civic address which follows the stree Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -316,6 +385,9 @@ Accept wildcard characters: False ``` ### -PreDirectional + +> Applicable: Microsoft Teams + Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue". **Note:** This parameter is not supported and is deprecated. @@ -324,7 +396,6 @@ Specifies the directional attribute of the civic address which precedes the stre Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -334,6 +405,9 @@ Accept wildcard characters: False ``` ### -StateOrProvince + +> Applicable: Microsoft Teams + Specifies the state or province of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -342,7 +416,6 @@ Specifies the state or province of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: State -Applicable: Microsoft Teams Required: False Position: Named @@ -352,6 +425,9 @@ Accept wildcard characters: False ``` ### -StreetName + +> Applicable: Microsoft Teams + Specifies the street name of the civic address. **Note:** This parameter is not supported and is deprecated. @@ -360,7 +436,6 @@ Specifies the street name of the civic address. Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -370,6 +445,9 @@ Accept wildcard characters: False ``` ### -StreetSuffix + +> Applicable: Microsoft Teams + Specifies the modifier of the street name. The street suffix will typically be something like street, avenue, way, or boulevard. **Note:** This parameter is not supported and is deprecated. @@ -378,7 +456,6 @@ Specifies the modifier of the street name. The street suffix will typically be s Type: String Parameter Sets: CreateCivicAddress Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -388,6 +465,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -395,23 +475,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -420,22 +483,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlinePSTNGateway.md similarity index 95% rename from teams/teams-ps/teams/New-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlinePSTNGateway.md index 0eba7e7d17..e790885b10 100644 --- a/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlinePSTNGateway.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway applicable: Microsoft Teams -title: New-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway +schema: 2.0.0 +title: New-CsOnlinePSTNGateway --- # New-CsOnlinePSTNGateway @@ -96,52 +98,6 @@ This example creates an SBC with FQDN sbc.contoso.com and signaling port 5061. F ## PARAMETERS -### -Identity -When creating a new SBC, the identity must be identical to the -FQDN parameter, described above. If the parameter is not defined the Identity will be copied from the -FQDN parameter. The Identity parameter is not mandatory. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fqdn -Limited to 63 characters, the FQDN registered for the SBC. Copied automatically to Identity of the SBC field. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SipSignalingPort -Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. Must be value between 1 and 65535. -Please note: Spelling of this parameter changed recently from SipSignallingPort to SipSignalingPort. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -BypassMode Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle. @@ -157,13 +113,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -172,13 +130,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Free-format string to describe the gateway. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -187,13 +147,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Microsoft Teams + Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC from service while it is being updated or during maintenance. Note if the parameter is not set the SBC will be created as disabled (default value -Enabled $false). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -202,6 +164,9 @@ Accept wildcard characters: False ``` ### -FailoverResponseCodes + +> Applicable: Microsoft Teams + If Direct Routing receives any 4xx or 6xx SIP error code in response to an outgoing Invite the call is considered completed by default. (Outgoing in this context is a call from a Teams client to the PSTN with traffic flow: Teams Client -> Direct Routing -> SBC -> Telephony network). Setting the SIP codes in this parameter forces Direct Routing on receiving the specified codes try another SBC (if another SBC exists in the voice routing policy of the user). Find more information in the "Reference" section of "Phone @@ -213,7 +178,6 @@ Setting this parameter overwrites the default values, so if you want to include Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 408, 503, 504 @@ -222,13 +186,15 @@ Accept wildcard characters: False ``` ### -FailoverTimeSeconds + +> Applicable: Microsoft Teams + When set to 10 (default value), outbound calls that are not answered by the gateway within 10 seconds are routed to the next available trunk; if there are no additional trunks, then the call is automatically dropped. In an organization with slow networks and slow gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 10 @@ -237,13 +203,15 @@ Accept wildcard characters: False ``` ### -ForwardCallHistory + +> Applicable: Microsoft Teams + Indicates whether call history information will be forwarded to the SBC. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -252,13 +220,49 @@ Accept wildcard characters: False ``` ### -ForwardPai + +> Applicable: Microsoft Teams + Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False). Setting this parameter to $true will render the from header anonymous, in accordance of RFC5379 and RFC3325. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams +Required: False +Position: Named +Default value: $false +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn + +> Applicable: Microsoft Teams + +Limited to 63 characters, the FQDN registered for the SBC. Copied automatically to Identity of the SBC field. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GatewayLbrEnabledUserOverride + +> Applicable: Microsoft Teams + +Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: $false @@ -267,13 +271,15 @@ Accept wildcard characters: False ``` ### -GatewaySiteId + +> Applicable: Microsoft Teams + PSTN Gateway Site Id. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -282,6 +288,9 @@ Accept wildcard characters: False ``` ### -GatewaySiteLbrEnabled + +> Applicable: Microsoft Teams + Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is enabled ($True), the SBC will report the site name as defined by the tenant administrator. On an incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False). @@ -290,7 +299,6 @@ the user to make a routing decision. The parameter is mandatory for enabling Loc Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -298,23 +306,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewayLbrEnabledUserOverride -Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. +### -Identity + +> Applicable: Microsoft Teams + +When creating a new SBC, the identity must be identical to the -FQDN parameter, described above. If the parameter is not defined the Identity will be copied from the -FQDN parameter. The Identity parameter is not mandatory. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: $false +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundTeamsNumberTranslationRules -This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. +### -InboundPSTNNumberTranslationRules +Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. ```yaml Type: Object @@ -327,8 +337,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundPSTNNumberTranslationRules -Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. +### -InboundTeamsNumberTranslationRules +This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. ```yaml Type: Object @@ -356,13 +366,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentSessions + +> Applicable: Microsoft Teams + Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent sessions is 90% or higher than this value. If the parameter is not set, alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -371,13 +383,15 @@ Accept wildcard characters: False ``` ### -MediaBypass + +> Applicable: Microsoft Teams + Parameter indicates if the SBC supports Media Bypass and the administrator wants to use it for this SBC. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -386,13 +400,15 @@ Accept wildcard characters: False ``` ### -MediaRelayRoutingLocationOverride + +> Applicable: Microsoft Teams + Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -429,13 +445,15 @@ Accept wildcard characters: False ``` ### -PidfloSupported + +> Applicable: Microsoft Teams + Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -444,13 +462,15 @@ Accept wildcard characters: False ``` ### -ProxySbc + +> Applicable: Microsoft Teams + The FQDN of the proxy SBC. Used in Local Media Optimization configurations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -459,13 +479,15 @@ Accept wildcard characters: False ``` ### -SendSipOptions + +> Applicable: Microsoft Teams + Defines if an SBC will or will not send SIP Options messages. If disabled, the SBC will be excluded from the Monitoring and Alerting system. We highly recommend that you enable SIP Options. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $true @@ -473,7 +495,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SipSignalingPort + +> Applicable: Microsoft Teams + +Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. Must be value between 1 and 65535. +Please note: Spelling of this parameter changed recently from SipSignallingPort to SipSignalingPort. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -481,7 +524,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/New-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineSchedule.md similarity index 96% rename from teams/teams-ps/teams/New-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineSchedule.md index 321a1e96c4..8810f6922a 100644 --- a/teams/teams-ps/teams/New-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule applicable: Microsoft Teams -title: New-CsOnlineSchedule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule +schema: 2.0.0 +title: New-CsOnlineSchedule --- # New-CsOnlineSchedule @@ -45,7 +47,7 @@ The New-CsOnlineSchedule cmdlet creates a new schedule for the Auto Attendant (A ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00 $tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00 @@ -54,7 +56,7 @@ $businessHours = New-CsOnlineSchedule -Name "Business Hours" -WeeklyRecurrentSch This example creates a weekly recurrent schedule that is active on Monday-Friday from 9AM-12PM and 1PM-5PM. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $tr1 = New-CsOnlineTimeRange -Start 09:00 -End 12:00 $tr2 = New-CsOnlineTimeRange -Start 13:00 -End 17:00 @@ -63,7 +65,7 @@ $afterHours = New-CsOnlineSchedule -Name " After Hours" -WeeklyRecurrentSchedule This example creates a weekly recurrent schedule that is active at all times except Monday-Friday, 9AM-12PM and 1PM-5PM. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $dtr = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" $christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -DateTimeRanges @($dtr) @@ -71,7 +73,7 @@ $christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -Date This example creates a fixed schedule that is active from December 24, 2017 to December 26, 2017. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell $dtr1 = New-CsOnlineDateTimeRange -Start "24/12/2017" -End "26/12/2017" $dtr2 = New-CsOnlineDateTimeRange -Start "24/12/2018" -End "26/12/2018" @@ -80,7 +82,7 @@ $christmasSchedule = New-CsOnlineSchedule -Name "Christmas" -FixedSchedule -Date This example creates a fixed schedule that is active from December 24, 2017 to December 26, 2017 and then from December 24, 2018 to December 26, 2018. -### -------------------------- Example 5 -------------------------- +### Example 5 ```powershell $notInEffectSchedule = New-CsOnlineSchedule -Name "NotInEffect" -FixedSchedule ``` @@ -89,55 +91,57 @@ This example creates a fixed schedule that is never active. ## PARAMETERS -### -Name -The Name parameter represents a unique friendly name for the schedule. +### -Complement +The Complement parameter indicates how the schedule is used. +When Complement is enabled, the schedule is used as the inverse of the provided configuration. +For example, if Complement is enabled and the schedule only contains time ranges of Monday to Friday from 9AM to 5PM, then the schedule is active at all times other than the specified time ranges. ```yaml -Type: System.String -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: WeeklyRecurrentSchedule Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WeeklyRecurrentSchedule -The WeeklyRecurrentSchedule parameter indicates that a weekly recurrent schedule is to be created. This parameter is mandatory when a weekly recurrent schedule is to be created. +### -DateTimeRanges +List of date-time ranges for a fixed schedule. At most, 10 date-time ranges can be specified using this parameter. ```yaml -Type: SwitchParameter -Parameter Sets: WeeklyRecurrentSchedule +Type: System.Collections.Generic.List +Parameter Sets: FixedSchedule Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MondayHours -List of time ranges for that day. +### -FixedSchedule +The FixedSchedule parameter indicates that a fixed schedule is to be created. ```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule +Type: SwitchParameter +Parameter Sets: FixedSchedule Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TuesdayHours +### -FridayHours List of time ranges for that day. ```yaml @@ -153,7 +157,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WednesdayHours +### -MondayHours List of time ranges for that day. ```yaml @@ -169,23 +173,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ThursdayHours -List of time ranges for that day. +### -Name +The Name parameter represents a unique friendly name for the schedule. ```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule +Type: System.String +Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -FridayHours +### -SaturdayHours List of time ranges for that day. ```yaml @@ -201,7 +205,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SaturdayHours +### -SundayHours List of time ranges for that day. ```yaml @@ -217,12 +221,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SundayHours -List of time ranges for that day. +### -Tenant ```yaml -Type: System.Collections.Generic.List -Parameter Sets: WeeklyRecurrentSchedule +Type: System.Guid +Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -233,13 +236,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Complement -The Complement parameter indicates how the schedule is used. -When Complement is enabled, the schedule is used as the inverse of the provided configuration. -For example, if Complement is enabled and the schedule only contains time ranges of Monday to Friday from 9AM to 5PM, then the schedule is active at all times other than the specified time ranges. +### -ThursdayHours +List of time ranges for that day. ```yaml -Type: SwitchParameter +Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: applicable: Microsoft Teams @@ -251,28 +252,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FixedSchedule -The FixedSchedule parameter indicates that a fixed schedule is to be created. +### -TuesdayHours +List of time ranges for that day. ```yaml -Type: SwitchParameter -Parameter Sets: FixedSchedule +Type: System.Collections.Generic.List +Parameter Sets: WeeklyRecurrentSchedule Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DateTimeRanges -List of date-time ranges for a fixed schedule. At most, 10 date-time ranges can be specified using this parameter. +### -WednesdayHours +List of time ranges for that day. ```yaml Type: System.Collections.Generic.List -Parameter Sets: FixedSchedule +Parameter Sets: WeeklyRecurrentSchedule Aliases: applicable: Microsoft Teams @@ -283,15 +284,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -WeeklyRecurrentSchedule +The WeeklyRecurrentSchedule parameter indicates that a weekly recurrent schedule is to be created. This parameter is mandatory when a weekly recurrent schedule is to be created. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: WeeklyRecurrentSchedule Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberOrder.md similarity index 97% rename from teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberOrder.md index e60b5f483c..d66a0ca76b 100644 --- a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberOrder.md @@ -1,13 +1,14 @@ --- +author: TristanChen-msft external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder -Module Name: MicrosoftTeams -title: New-CsOnlineTelephoneNumberOrder -schema: 2.0.0 +Locale: en-US manager: mreddy -author: TristanChen-msft +Module Name: MicrosoftTeams ms.author: jiaych ms.reviewer: julienp +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder +schema: 2.0.0 +title: New-CsOnlineTelephoneNumberOrder --- # New-CsOnlineTelephoneNumberOrder @@ -35,7 +36,7 @@ Telephone numbers can be created with 3 ways: ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 1" -Description "Civic address search example" -Country "US" -NumberType "UserSubscriber" -Quantity 1 -CivicAddressId 3b175352-4131-431e-970c-273226b8fb46 PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId @@ -68,7 +69,7 @@ New York City +17182000004 This example demonstrates a civic address based telephone number search. Telephone number +17182000004 is found to belong to the given address and is reserved for purchase. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 2" -Description "Number prefix search example" -Country "US" -NumberType "UserSubscriber" -Quantity 1 -NumberPrefix 1425 PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId @@ -101,7 +102,7 @@ Bellevue +14252000004 This example demonstrates a number prefix based telephone number search. Telephone number +14252000004 is found to have the desired number prefix and is reserved for purchase. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 3" -Description "Area code selection search example" -Country "US" -NumberType "ConferenceTollFree" -Quantity 1 -AreaCode 800 PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId diff --git a/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberReleaseOrder.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberReleaseOrder.md new file mode 100644 index 0000000000..211089245f --- /dev/null +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTelephoneNumberReleaseOrder.md @@ -0,0 +1,179 @@ +--- +applicable: Microsoft Teams +author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams +ms.author: pavellatif +ms.reviewer: pavellatif +online version: online version: https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder +schema: 2.0.0 +title: New-CsOnlineTelephoneNumberReleaseOrder +--- + +# New-CsOnlineTelephoneNumberReleaseOrder + +## SYNOPSIS + +This cmdlet creates a request to release telephone numbers from Microsoft Teams telephone number +management inventory. + +## SYNTAX + +``` +New-CsOnlineTelephoneNumberReleaseOrder [-TelephoneNumber ] [-StartingNumber ] + [-EndingNumber ] [-FileContent ] [] +``` + +## DESCRIPTION + +This cmdlet releases existing telephone numbers from Microsoft Teams telephone number management +inventory. Once released the phone numbers will not be visible in Teams PowerShell as acquired +telephone numbers. A maximum of 1,000 phone numbers can be released at a time. If more than 1,000 +numbers need to be released, the requests should be divided into multiple increments of up to 1,000 +numbers. + +The cmdlet is an asynchronous operation and will return an OrderId as output. You can use the +[Get-CsOnlineTelephoneNumberOrder](get-csonlinetelephonenumberorder.md) +cmdlet to check the status of the OrderId, including any error or warning messages that might result +from the operation: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a telephone number "+123456789" is being released from Microsoft Teams telephone +number management inventory. + +### Example 2 + +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789,+134567890,+145678901" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a list of telephone numbers are being released from Microsoft Teams telephone +number management. + +### Example 3 + +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -StartingNumber "+12000000" -EndingNumber "+12000009" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a range of telephone numbers from "+12000000" to "+12000009" are being released from Microsoft Teams telephone number management. + +### Example 4 + +```powershell +PS C:\> $drlist = [System.IO.File]::ReadAllBytes("C:\Users\testuser\DrNumber.csv") +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -FileContent $drlist +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, the content of a file with a list of telephone numbers are being released via file upload. The file should be in Comma Separated Values (CSV) file format and should only contain the list of telephone numbers to be released. The `New-CsOnlineTelephoneNumberReleaseOrder` cmdlet is only used to pass the content. + +## PARAMETERS + +### -EndingNumber + +This is the ending number of a range of telephone number you wish to release from your tenant in +Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileContent + +This is the content of a .csv file that includes the telephone numbers to be released from the +Microsoft Teams telephone number management inventory. This parameter can be used to release up to +1,000 numbers at a time. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartingNumber + +This is the starting number of a range of telephone number you wish to release from your tenant in +Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber + +This is the telephone number you wish to release from your tenant in Microsoft Teams telephone +number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES + +The cmdlet is available in Teams PowerShell module 6.7.1 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS + +[Get-CsOnlineTelephoneNumberOrder](get-csonlinetelephonenumberorder.md) + +[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](new-csonlinedirectroutingtelephonenumberuploadorder.md) diff --git a/teams/teams-ps/teams/New-CsOnlineTimeRange.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTimeRange.md similarity index 94% rename from teams/teams-ps/teams/New-CsOnlineTimeRange.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineTimeRange.md index e331b4ffe5..344bc8fbcf 100644 --- a/teams/teams-ps/teams/New-CsOnlineTimeRange.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineTimeRange.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange applicable: Microsoft Teams -title: New-CsOnlineTimeRange -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange +schema: 2.0.0 +title: New-CsOnlineTimeRange --- # New-CsOnlineTimeRange @@ -31,14 +33,14 @@ The New-CsOnlineTimeRange cmdlet creates a new time range to be used with the Au ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $workdayTimeRange = New-CsOnlineTimeRange -Start 09:00 -End 17:00 ``` This example creates a time range for a 9AM to 5PM work day. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $allDayTimeRange = New-CsOnlineTimeRange -Start 00:00 -End 1.00:00 ``` @@ -47,8 +49,8 @@ This example creates a 24-hour time range. ## PARAMETERS -### -Start -The Start parameter represents the start bound of the time range. +### -End +The End parameter represents the end bound of the time range. ```yaml Type: System.TimeSpan @@ -63,8 +65,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -End -The End parameter represents the end bound of the time range. +### -Start +The Start parameter represents the start bound of the time range. ```yaml Type: System.TimeSpan diff --git a/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoute.md similarity index 94% rename from teams/teams-ps/teams/New-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoute.md index 270d9deed1..399eb789af 100644 --- a/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoute.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute applicable: Microsoft Teams -title: New-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute +schema: 2.0.0 +title: New-CsOnlineVoiceRoute --- # New-CsOnlineVoiceRoute ## SYNOPSIS -Creates a new online voice route. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). +Creates a new online voice route. ## SYNTAX @@ -34,27 +35,29 @@ New-CsOnlineVoiceRoute [-BridgeSourcePhoneNumber ] [-Description New-CsOnlineVoiceRoute -Identity Route1 ``` The command in this example creates a new online voice route with an Identity of Route1. All other properties will be set to the default values. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> New-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{add="Long Distance"} -OnlinePstnGatewayList @{add="sbc1.litwareinc.com"} ``` The command in this example creates a new online voice route with an Identity of Route1. It also adds the online PSTN usage Long Distance to the list of usages and the service ID PstnGateway sbc1.litwareinc.com to the list of online PSTN gateways. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> $x = (Get-CsOnlinePstnUsage).Usage diff --git a/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy.md similarity index 96% rename from teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy.md index a4646da2fa..0477ac7280 100644 --- a/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: New-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: New-CsOnlineVoiceRoutingPolicy --- # New-CsOnlineVoiceRoutingPolicy @@ -30,14 +31,14 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> New-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages "Long Distance" ``` The command shown in Example 1 creates a new online per-user voice routing policy with the Identity RedmondOnlineVoiceRoutingPolicy. This policy is assigned a single online PSTN usage: Long Distance. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> New-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages "Long Distance", "Local", "Internal" ``` diff --git a/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoicemailPolicy.md similarity index 84% rename from teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsOnlineVoicemailPolicy.md index 04a4f92099..4c1f81c496 100644 --- a/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsOnlineVoicemailPolicy.md @@ -1,35 +1,44 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy applicable: Microsoft Teams -title: New-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy +schema: 2.0.0 +title: New-CsOnlineVoicemailPolicy --- # New-CsOnlineVoicemailPolicy ## SYNOPSIS -Creates a new Online Voicemail policy. Online Voicemail policies determine whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. +Creates a new Online Voicemail policy. ## SYNTAX ### Identity (Default) -```powershell -New-CsOnlineVoicemailPolicy [-Identity] [-EnableEditingCallAnswerRulesSetting ] [-EnableTranscription ] -[-EnableTranscriptionProfanityMasking ] [-EnableTranscriptionTranslation ] [-MaximumRecordingLength ] -[-PostAmbleAudioFile ] [-PreambleAudioFile ] [-PreamblePostambleMandatory ] -[-PrimarySystemPromptLanguage ] [-SecondarySystemPromptLanguage ] [-ShareData ] [-WhatIf] [-Confirm] [-Description ] [] +``` +New-CsOnlineVoicemailPolicy [-Identity] [-EnableEditingCallAnswerRulesSetting ] + [-EnableTranscription ] [-EnableTranscriptionProfanityMasking ] + [-EnableTranscriptionTranslation ] [-MaximumRecordingLength ] + [-PostAmbleAudioFile ] [-PreambleAudioFile ] + [-PreamblePostambleMandatory ] [-PrimarySystemPromptLanguage ] + [-SecondarySystemPromptLanguage ] [-ShareData ] [-WhatIf] [-Confirm] + [-Description ] [] ``` ## DESCRIPTION -Cloud Voicemail service provides organizations with voicemail deposit capabilities for Phone System implementation. +Cloud Voicemail service provides organizations with voicemail deposit capabilities for Phone System +implementation. -By default, users enabled for Phone System will be enabled for Cloud Voicemail. The Online Voicemail policy controls whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. +By default, users enabled for Phone System will be enabled for Cloud Voicemail. The Online Voicemail +policy controls whether or not voicemail transcription, profanity masking for the voicemail +transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings +are enabled for a user. The policies also specify the voicemail maximum recording length for a user +and the primary and secondary voicemail system prompt languages. - Voicemail transcription is enabled by default - Transcription profanity masking is disabled by default @@ -42,7 +51,7 @@ Tenant admin would be able to create a customized online voicemail policy to mat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" -MaximumRecordingLength ([TimeSpan]::FromSeconds(60)) ``` @@ -51,21 +60,38 @@ The command shown in Example 1 creates a per-user online voicemail policy Custom ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -EnableEditingCallAnswerRulesSetting Controls if editing call answer rule settings are enabled or disabled for a user. Possible values are $true or $false. @@ -130,6 +156,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -MaximumRecordingLength A duration of voicemail maximum recording length. The length should be between 30 seconds to 10 minutes. @@ -257,38 +298,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md b/teams/teams-ps/MicrosoftTeams/New-CsSdgBulkSignInRequest.md similarity index 99% rename from teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md rename to teams/teams-ps/MicrosoftTeams/New-CsSdgBulkSignInRequest.md index 3c44267712..d2ec0a7383 100644 --- a/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsSdgBulkSignInRequest.md @@ -1,10 +1,10 @@ --- +applicable: Microsoft Teams external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -online version: -title: New-CsSdgBulkSignInRequest schema: 2.0.0 +title: New-CsSdgBulkSignInRequest --- # New-CsSdgBulkSignInRequest diff --git a/teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsSharedCallQueueHistoryTemplate.md similarity index 92% rename from teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsSharedCallQueueHistoryTemplate.md index f71b11582d..d7c42fc1a5 100644 --- a/teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsSharedCallQueueHistoryTemplate.md @@ -1,22 +1,27 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/New-CsSharedCallQueueHistoryTemplate applicable: Microsoft Teams -title: New-CsSharedCallQueueHistoryTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/New-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: New-CsSharedCallQueueHistoryTemplate --- # New-CsSharedCallQueueHistoryTemplate +## SYNOPSIS +Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue History template. + ## SYNTAX -```powershell -New-CsSharedCallQueueHistoryTemplate -Name -Description [-IncomingMissedCalls ] [-AnsweredAndOutboundCalls ] [] -``` +``` +New-CsSharedCallQueueHistoryTemplate -Name -Description + [-IncomingMissedCalls ] [-AnsweredAndOutboundCalls ] [] +``` ## DESCRIPTION Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue History template. @@ -26,7 +31,7 @@ Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue Histor ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsSharedCallQueueHistoryTemplate -Name "Customer Service" -Description "Missed:All Answered:Auth" -IncomingMissedCall XXXXXX -AnsweredAndOutboundCalls XXXXX ``` @@ -35,18 +40,20 @@ This example creates a new Shared CallQueue History template where incoming miss ## PARAMETERS -### -Name -The name of the shared call queue history template. +### -AnsweredAndOutboundCalls +A description for the shared call queue history template. + +PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents ```yaml -Type: System.String +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named -Default value: None +Default value: Off Accept pipeline input: False Accept wildcard characters: False ``` @@ -85,20 +92,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AnsweredAndOutboundCalls -A description for the shared call queue history template. - -PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents +### -Name +The name of the shared call queue history template. ```yaml -Type: Object +Type: System.String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named -Default value: Off +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsTeamTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamTemplate.md similarity index 96% rename from teams/teams-ps/teams/New-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamTemplate.md index 4230e09bf3..5fc960f4bd 100644 --- a/teams/teams-ps/teams/New-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamTemplate.md @@ -1,810 +1,813 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate -title: New-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# New-CsTeamTemplate - -## SYNOPSIS - -This cmdlet lets you provision a new team template for use in Microsoft Teams. To learn more about team templates, see [Get started with Teams templates in the admin center](https://learn.microsoft.com/microsoftteams/get-started-with-teams-templates-in-the-admin-console). - -NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. - -## SYNTAX - -### NewExpanded (Default) - -```powershell -New-CsTeamTemplate -Locale -DisplayName -ShortDescription - [-App ] [-Category ] [-Channel ] - [-Classification ] [-Description ] [-DiscoverySetting ] - [-FunSetting ] [-GuestSetting ] [-Icon ] - [-IsMembershipLimitedToOwner] [-MemberSetting ] - [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] - [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### New - -```powershell -New-CsTeamTemplate -Locale -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### NewViaIdentity - -```powershell -New-CsTeamTemplate -InputObject -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### NewViaIdentityExpanded - -```powershell -New-CsTeamTemplate -InputObject -DisplayName - -ShortDescription [-App ] [-Category ] - [-Channel ] [-Classification ] [-Description ] - [-DiscoverySetting ] [-FunSetting ] - [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] - [-MemberSetting ] [-MessagingSetting ] - [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] - [-Uri ] [-Visibility ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US') > input.json -# open json in your favorite editor, make changes - -PS C:\> New-CsTeamTemplate -Locale en-US -Body (Get-Content '.input.json' | Out-String) -``` - -Step 1: Create new template from copy of existing template. Gets the template JSON file of Template with specified OData ID, creates a JSON file user can make edits in. -Step 2: Create a new template from the JSON file named "input". - -### EXAMPLE 2 - -```powershell -PS C:\> $template = Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US' -PS C:\> $template | Format-List # show the output object as it would be accessed - -PS C:\> $template.Category = $null # unset category to copy from public template -PS C:\> $template.DisplayName = 'New Template from object' -PS C:\> $template.Channel[1].DisplayName += ' modified' -## add a new channel to the channel list -PS C:\> $template.Channel += ` -@{ ` - displayName="test"; ` - id="b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` - isFavoriteByDefault=$false; ` -} - -PS C:\> New-CsTeamTemplate -Locale en-US -Body $template -``` - -Create a template using a complex object syntax. - -### EXAMPLE 3 - -```powershell -PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` -DisplayName='New Template';` -ShortDescription='Short Definition';` -Description='New Description';` -App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` -Channel=@{` - displayName = "General";` - id= "General";` - isFavoriteByDefault= $true` - },` - @{` - displayName= "test";` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` - isFavoriteByDefault= $false` - }` -} - -PS C:\> New-CsTeamTemplate -Locale en-US -Body $template -``` - -Create template from scratch - -> [!Note] -> It can take up to 24 hours for Teams users to see a custom template change in the gallery. - -## PARAMETERS - -### -App - -Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. -To construct, see NOTES section for APP properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body - -The client input for a request to create a template. -Only admins from Config Api can perform this request. -To construct, see NOTES section for BODY properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate -Parameter Sets: New, NewViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category - -Gets or sets list of categories. - -```yaml -Type: System.String[] -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Channel - -Gets or sets the set of channel templates included in the team template. -To construct, see NOTES section for CHANNEL properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Classification - -Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Gets or sets the team's Description. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoverySetting - -Governs discoverability of a team. -To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName - -Gets or sets the team's DisplayName. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunSetting - -Governs use of fun media like giphy and stickers in the team. -To construct, see NOTES section for FUNSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestSetting - -Guest role settings for the team. -To construct, see NOTES section for GUESTSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Icon - -Gets or sets template icon. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity -Parameter Sets: NewViaIdentity, NewViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsMembershipLimitedToOwner - -Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Locale - -```yaml -Type: System.String -Parameter Sets: New, NewExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberSetting - -Member role settings for the team. -To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessagingSetting - -Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. -To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerUserObjectId - -Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishedBy - -Gets or sets published name. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShortDescription - -Gets or sets template short description. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Specialization - -The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateId - -Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri - -Gets or sets uri to be used for GetTemplate api call. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Visibility - -Used to control the scope of users who can view a group/team and its members, and ability to join. - -```yaml -Type: System.String -Parameter Sets: NewExpanded, NewViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateErrorResponse - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -APP : Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. - -- `[Id ]`: Gets or sets the app's ID in the global apps catalog. - -BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. - -- `DisplayName `: Gets or sets the team's DisplayName. -- `ShortDescription `: Gets or sets template short description. -- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. - - `[Id ]`: Gets or sets the app's ID in the global apps catalog. -- `[Category ]`: Gets or sets list of categories. -- `[Channel ]`: Gets or sets the set of channel templates included in the team template. - - `[Description ]`: Gets or sets channel description as displayed to users. - - `[DisplayName ]`: Gets or sets channel name as displayed to users. - - `[Id ]`: Gets or sets identifier for the channel template. - - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - - `[Configuration ]`: Represents the configuration of a tab. - - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. -- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. -- `[Description ]`: Gets or sets the team's Description. -- `[DiscoverySetting ]`: Governs discoverability of a team. - - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. -- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. - - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. - - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - - `GiphyContentRating `: Gets or sets the rating filter on giphy content. -- `[GuestSetting ]`: Guest role settings for the team. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. -- `[Icon ]`: Gets or sets template icon. -- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. -- `[MemberSetting ]`: Member role settings for the team. - - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. - - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. - - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. - - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. -- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. - - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. -- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. -- `[PublishedBy ]`: Gets or sets published name. -- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. -- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. -- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. -- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. - -CHANNEL : Gets or sets the set of channel templates included in the team template. - -- `[Description ]`: Gets or sets channel description as displayed to users. -- `[DisplayName ]`: Gets or sets channel name as displayed to users. -- `[Id ]`: Gets or sets identifier for the channel template. -- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. -- `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - - `[Configuration ]`: Represents the configuration of a tab. - - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. - -DISCOVERYSETTING \: Governs discoverability of a team. - -- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - -FUNSETTING \: Governs use of fun media like giphy and stickers in the team. - -- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. -- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. -- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. -- `GiphyContentRating `: Gets or sets the rating filter on giphy content. - -GUESTSETTING \: Guest role settings for the team. - -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. - -INPUTOBJECT \: Identity Parameter - -- `[Bssid ]`: -- `[ChassisId ]`: -- `[CivicAddressId ]`: Civic address id. -- `[Country ]`: -- `[GroupId ]`: The ID of a group whose policy assignments will be returned. -- `[Id ]`: -- `[Identity ]`: -- `[Locale ]`: -- `[LocationId ]`: Location id. -- `[OdataId ]`: A composite URI of a template. -- `[OperationId ]`: The ID of a batch policy assignment operation. -- `[OrderId ]`: -- `[PackageName ]`: The name of a specific policy package -- `[PolicyType ]`: The policy type for which group policy assignments will be returned. -- `[Port ]`: -- `[PortInOrderId ]`: -- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. -- `[SubnetId ]`: -- `[TenantId ]`: -- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -MEMBERSETTING \: Member role settings for the team. - -- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. -- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. -- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. -- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. -- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. - -MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. - -- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. -- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. -- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. -- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. -- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - -## RELATED LINKS - -- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate +schema: 2.0.0 +title: New-CsTeamTemplate +--- + +# New-CsTeamTemplate + +## SYNOPSIS + +This cmdlet lets you provision a new team template for use in Microsoft Teams. + +## SYNTAX + +### NewExpanded (Default) + +``` +New-CsTeamTemplate -Locale -DisplayName -ShortDescription + [-App ] [-Category ] [-Channel ] + [-Classification ] [-Description ] [-DiscoverySetting ] + [-FunSetting ] [-GuestSetting ] [-Icon ] + [-IsMembershipLimitedToOwner] [-MemberSetting ] + [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] + [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### New + +``` +New-CsTeamTemplate -Locale -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### NewViaIdentity + +``` +New-CsTeamTemplate -InputObject -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### NewViaIdentityExpanded + +``` +New-CsTeamTemplate -InputObject -DisplayName + -ShortDescription [-App ] [-Category ] + [-Channel ] [-Classification ] [-Description ] + [-DiscoverySetting ] [-FunSetting ] + [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] + [-MemberSetting ] [-MessagingSetting ] + [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] + [-Uri ] [-Visibility ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +To learn more about team templates, see [Get started with Teams templates in the admin center](/microsoftteams/get-started-with-teams-templates-in-the-admin-console). + +NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. + + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US') > input.json +# open json in your favorite editor, make changes + +PS C:\> New-CsTeamTemplate -Locale en-US -Body (Get-Content '.input.json' | Out-String) +``` + +Step 1: Create new template from copy of existing template. Gets the template JSON file of Template with specified OData ID, creates a JSON file user can make edits in. +Step 2: Create a new template from the JSON file named "input". + +### EXAMPLE 2 + +```powershell +PS C:\> $template = Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US' +PS C:\> $template | Format-List # show the output object as it would be accessed + +PS C:\> $template.Category = $null # unset category to copy from public template +PS C:\> $template.DisplayName = 'New Template from object' +PS C:\> $template.Channel[1].DisplayName += ' modified' +## add a new channel to the channel list +PS C:\> $template.Channel += ` +@{ ` + displayName="test"; ` + id="b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` + isFavoriteByDefault=$false; ` +} + +PS C:\> New-CsTeamTemplate -Locale en-US -Body $template +``` + +Create a template using a complex object syntax. + +### EXAMPLE 3 + +```powershell +PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` +DisplayName='New Template';` +ShortDescription='Short Definition';` +Description='New Description';` +App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` +Channel=@{` + displayName = "General";` + id= "General";` + isFavoriteByDefault= $true` + },` + @{` + displayName= "test";` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` + isFavoriteByDefault= $false` + }` +} + +PS C:\> New-CsTeamTemplate -Locale en-US -Body $template +``` + +Create template from scratch + +> [!Note] +> It can take up to 24 hours for Teams users to see a custom template change in the gallery. + +## PARAMETERS + +### -App + +Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. +To construct, see NOTES section for APP properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body + +The client input for a request to create a template. +Only admins from Config Api can perform this request. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate +Parameter Sets: New, NewViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break + +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category + +Gets or sets list of categories. + +```yaml +Type: System.String[] +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Channel + +Gets or sets the set of channel templates included in the team template. +To construct, see NOTES section for CHANNEL properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Classification + +Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Gets or sets the team's Description. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoverySetting + +Governs discoverability of a team. +To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName + +Gets or sets the team's DisplayName. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunSetting + +Governs use of fun media like giphy and stickers in the team. +To construct, see NOTES section for FUNSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestSetting + +Guest role settings for the team. +To construct, see NOTES section for GUESTSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend + +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend + +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Icon + +Gets or sets template icon. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: NewViaIdentity, NewViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsMembershipLimitedToOwner + +Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locale + +```yaml +Type: System.String +Parameter Sets: New, NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberSetting + +Member role settings for the team. +To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingSetting + +Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. +To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerUserObjectId + +Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy + +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential + +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials + +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishedBy + +Gets or sets published name. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShortDescription + +Gets or sets template short description. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Specialization + +The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateId + +Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri + +Gets or sets uri to be used for GetTemplate api call. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Visibility + +Used to control the scope of users who can view a group/team and its members, and ability to join. + +```yaml +Type: System.String +Parameter Sets: NewExpanded, NewViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplateErrorResponse + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +APP : Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. + +- `[Id ]`: Gets or sets the app's ID in the global apps catalog. + +BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. + +- `DisplayName `: Gets or sets the team's DisplayName. +- `ShortDescription `: Gets or sets template short description. +- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. + - `[Id ]`: Gets or sets the app's ID in the global apps catalog. +- `[Category ]`: Gets or sets list of categories. +- `[Channel ]`: Gets or sets the set of channel templates included in the team template. + - `[Description ]`: Gets or sets channel description as displayed to users. + - `[DisplayName ]`: Gets or sets channel name as displayed to users. + - `[Id ]`: Gets or sets identifier for the channel template. + - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. + - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration ]`: Represents the configuration of a tab. + - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. +- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. +- `[Description ]`: Gets or sets the team's Description. +- `[DiscoverySetting ]`: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. +- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. + - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. + - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. + - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. + - `GiphyContentRating `: Gets or sets the rating filter on giphy content. +- `[GuestSetting ]`: Guest role settings for the team. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. +- `[Icon ]`: Gets or sets template icon. +- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. +- `[MemberSetting ]`: Member role settings for the team. + - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. + - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. + - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. + - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. + - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. +- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. + - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. + - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. + - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. + - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. + - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. +- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. +- `[PublishedBy ]`: Gets or sets published name. +- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. +- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. +- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. +- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. + +CHANNEL : Gets or sets the set of channel templates included in the team template. + +- `[Description ]`: Gets or sets channel description as displayed to users. +- `[DisplayName ]`: Gets or sets channel name as displayed to users. +- `[Id ]`: Gets or sets identifier for the channel template. +- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. +- `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration ]`: Represents the configuration of a tab. + - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. + +DISCOVERYSETTING \: Governs discoverability of a team. + +- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. + +FUNSETTING \: Governs use of fun media like giphy and stickers in the team. + +- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. +- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. +- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. +- `GiphyContentRating `: Gets or sets the rating filter on giphy content. + +GUESTSETTING \: Guest role settings for the team. + +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. + +INPUTOBJECT \: Identity Parameter + +- `[Bssid ]`: +- `[ChassisId ]`: +- `[CivicAddressId ]`: Civic address id. +- `[Country ]`: +- `[GroupId ]`: The ID of a group whose policy assignments will be returned. +- `[Id ]`: +- `[Identity ]`: +- `[Locale ]`: +- `[LocationId ]`: Location id. +- `[OdataId ]`: A composite URI of a template. +- `[OperationId ]`: The ID of a batch policy assignment operation. +- `[OrderId ]`: +- `[PackageName ]`: The name of a specific policy package +- `[PolicyType ]`: The policy type for which group policy assignments will be returned. +- `[Port ]`: +- `[PortInOrderId ]`: +- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. +- `[SubnetId ]`: +- `[TenantId ]`: +- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +MEMBERSETTING \: Member role settings for the team. + +- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. +- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. +- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. +- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. +- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. + +MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. + +- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. +- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. +- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. +- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. +- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. + +## RELATED LINKS + +- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) diff --git a/teams/teams-ps/teams/New-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAIPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAIPolicy.md index 4a7ff4af67..a4231a7ac0 100644 --- a/teams/teams-ps/teams/New-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: Andy447 external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: New-CsTeamsAIPolicy +ms.author: andywang online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsAIPolicy schema: 2.0.0 -author: Andy447 -ms.author: andywang +title: New-CsTeamsAIPolicy --- # New-CsTeamsAIPolicy @@ -42,15 +43,15 @@ The newly created policy with value will be printed on success. ## PARAMETERS -### -Identity -Identity of the Teams AI policy. - +### -Description +Enables administrators to provide explanatory text about the Teams AI policy. +For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -87,32 +88,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpeakerAttributionBYOD -Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. +### -Identity +Identity of the Teams AI policy. ```yaml Type: String -Parameter Sets: ("Enabled","Disabled") +Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text about the Teams AI policy. -For example, the Description might indicate the users the policy should be assigned to. +### -SpeakerAttributionBYOD +Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. + ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: ("Enabled","Disabled") Aliases: -Required: False +Required: True Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppPermissionPolicy.md similarity index 71% rename from teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAppPermissionPolicy.md index ff4308f76f..cbf16b4e66 100644 --- a/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppPermissionPolicy.md @@ -1,24 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsapppermissionpolicy applicable: Microsoft Teams -title: New-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: mhayrapetyan +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsapppermissionpolicy +schema: 2.0.0 +title: New-CsTeamsAppPermissionPolicy --- # New-CsTeamsAppPermissionPolicy ## SYNOPSIS - -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. - -As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . - -**This is only applicable for tenants who have not been migrated to ACM or UAM.** +As an admin, you can use app permission policies to allow or block apps for your users. ## SYNTAX @@ -41,9 +38,12 @@ New-CsTeamsAppPermissionPolicy [[-Identity] ] ## DESCRIPTION **NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. +While the cmdlet may succeed, the changes aren't applied to the tenant. As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppSetupPolicy.md similarity index 85% rename from teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAppSetupPolicy.md index ff00d0c8a6..532a76df1b 100644 --- a/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAppSetupPolicy.md @@ -1,19 +1,17 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsappsetuppolicy -applicable: Microsoft Teams -title: New-CsTeamsAppSetupPolicy schema: 2.0.0 +title: New-CsTeamsAppSetupPolicy --- # New-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. ## SYNTAX @@ -36,11 +34,21 @@ New-CsTeamsAppSetupPolicy [-Identity] ``` ## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this +cmdlet. We require that all creation and modification of app setup polices (not including the +assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business +Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that +are most important for your users. You choose the apps to pin and set the order that they appear. +App setup policies let you showcase apps that users in your organization need, including ones built +by third parties or by developers in your organization. You can also use app setup policies to +manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the +bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: +. ## EXAMPLES @@ -99,16 +107,16 @@ Create a new TeamsAppSetupPolicy and install VivaConnections App in users' perso ## PARAMETERS -### -Identity -Name of App setup policy. If empty, all Identities will be used by default. +### -AdditionalCustomizationApps +This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. ```yaml -Type: String -Parameter Sets: Identity +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -159,13 +167,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -AppPresetMeetingList +This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -174,13 +182,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the app setup policy. +### -Confirm +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -189,11 +197,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinnedAppBarApps -Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that are needed the most by users and promote ease of access. +### -Description +Description of the app setup policy. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] +Type: String Parameter Sets: (All) Aliases: @@ -204,26 +212,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinnedCallingBarApps -Determines the list of apps that are pre pinned for a participant in Calls. +### -Identity +Name of App setup policy. If empty, all Identities will be used by default. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PinnedMessageBarApps -Apps are pinned in messaging extensions and into the ellipsis menu. +### -PinnedAppBarApps +Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that are needed the most by users and promote ease of access. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] Parameter Sets: (All) Aliases: @@ -234,11 +242,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdditionalCustomizationApps -This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. +### -PinnedCallingBarApps +Determines the list of apps that are pre pinned for a participant in Calls. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] Parameter Sets: (All) Aliases: @@ -249,11 +257,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppPresetMeetingList -This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. +### -PinnedMessageBarApps +Apps are pinned in messaging extensions and into the ellipsis menu. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] Parameter Sets: (All) Aliases: diff --git a/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy.md index e95b230bdc..1bf50640ac 100644 --- a/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy -title: New-CsTeamsAudioConferencingPolicy schema: 2.0.0 +title: New-CsTeamsAudioConferencingPolicy --- # New-CsTeamsAudioConferencingPolicy @@ -53,6 +54,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. @@ -113,21 +129,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallHoldPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCallHoldPolicy.md index 92744364e9..2cae685831 100644 --- a/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy applicable: Microsoft Teams -title: New-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy +schema: 2.0.0 +title: New-CsTeamsCallHoldPolicy --- # New-CsTeamsCallHoldPolicy @@ -42,16 +43,31 @@ Any Microsoft Teams users who are assigned this policy will have their call hold ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new Teams call hold policy. +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -74,11 +90,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFileId -A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -89,16 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreamingSourceUrl -This parameter is reserved for internal Microsoft use. +### -Identity +Unique identifier to be assigned to the new Teams call hold policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -119,11 +135,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -150,21 +166,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallParkPolicy.md similarity index 82% rename from teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCallParkPolicy.md index ba4ca721a7..548748e9f0 100644 --- a/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallParkPolicy.md @@ -1,33 +1,40 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallparkpolicy applicable: Microsoft Teams -title: New-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallparkpolicy +schema: 2.0.0 +title: New-CsTeamsCallParkPolicy --- # New-CsTeamsCallParkPolicy ## SYNOPSIS - -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. - -NOTE: The call park feature currently available in desktop. mobile and web clients. Supported with TeamsOnly mode. +The New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. ## SYNTAX ### Identity (Default) -```powershell -New-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [[-Identity] ] [-PickupRangeStart ] [-PickupRangeEnd ] [-ParkTimeoutSeconds ] [-Force] [-WhatIf] [-Confirm] [-Description ] [] + +``` +New-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [[-Identity] ] + [-PickupRangeStart ] [-PickupRangeEnd ] [-ParkTimeoutSeconds ] [-Force] + [-WhatIf] [-Confirm] [-Description ] [] ``` ## DESCRIPTION -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different phone. The New-CsTeamsCallParkPolicy cmdlet lets you create a new custom policy that can then be assigned to one or more specific users. +The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in +Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then +perform a number of actions on that call: transfer to another department, retrieve via the same +phone, or retrieve via a different phone. + +NOTE: The call park feature currently available in desktop. mobile and web clients. Supported with TeamsOnly mode. ## EXAMPLES @@ -84,6 +91,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppress all non-fatal errors. @@ -114,10 +136,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PickupRangeEnd -Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. - -Note: PickupRangeStart must be smaller than PickupRangeEnd. +### -ParkTimeoutSeconds +Specify the number of seconds to wait before ringing the parker when the parked call hasn't been picked up. Value can be from 120 to 1800 (seconds). ```yaml Type: Integer @@ -126,13 +146,15 @@ Aliases: Required: False Position: Named -Default value: 99 +Default value: 300 Accept pipeline input: False Accept wildcard characters: False ``` -### -ParkTimeoutSeconds -Specify the number of seconds to wait before ringing the parker when the parked call hasn't been picked up. Value can be from 120 to 1800 (seconds). +### -PickupRangeEnd +Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. + +Note: PickupRangeStart must be smaller than PickupRangeEnd. ```yaml Type: Integer @@ -141,7 +163,7 @@ Aliases: Required: False Position: Named -Default value: 300 +Default value: 99 Accept pipeline input: False Accept wildcard characters: False ``` @@ -194,21 +216,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallingPolicy.md similarity index 94% rename from teams/teams-ps/teams/New-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCallingPolicy.md index 638a131b09..9a9c578e4c 100644 --- a/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCallingPolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy applicable: Microsoft Teams -title: New-CsTeamsCallingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars ms.reviewer: alejandramu +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy +schema: 2.0.0 +title: New-CsTeamsCallingPolicy --- # New-CsTeamsCallingPolicy @@ -72,22 +73,10 @@ values in the Global policy instance. ## PARAMETERS -### -Identity -Name of the policy instance being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter > [!NOTE] > This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -102,7 +91,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -112,13 +100,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToPhone + +> Applicable: Microsoft Teams + Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -128,13 +118,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToUser + +> Applicable: Microsoft Teams + Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -144,13 +136,15 @@ Accept wildcard characters: False ``` ### -AllowCallGroups + +> Applicable: Microsoft Teams + Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -160,6 +154,9 @@ Accept wildcard characters: False ``` ### -AllowCallRedirect + +> Applicable: Microsoft Teams + Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway. Valid options are: @@ -172,7 +169,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -182,13 +178,15 @@ Accept wildcard characters: False ``` ### -AllowCloudRecordingForCalls + +> Applicable: Microsoft Teams + Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -198,13 +196,15 @@ Accept wildcard characters: False ``` ### -AllowDelegation + +> Applicable: Microsoft Teams + Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -214,6 +214,9 @@ Accept wildcard characters: False ``` ### -AllowPrivateCalling + +> Applicable: Microsoft Teams + Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. @@ -221,7 +224,6 @@ If you use Skype for Business for calling, this policy will not affect calling f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -231,13 +233,15 @@ Accept wildcard characters: False ``` ### -AllowSIPDevicesCalling + +> Applicable: Microsoft Teams + Determines whether the user is allowed to use a SIP device for calling on behalf of a Teams client. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -247,13 +251,15 @@ Accept wildcard characters: False ``` ### -AllowTranscriptionForCalling + +> Applicable: Microsoft Teams + Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -263,6 +269,9 @@ Accept wildcard characters: False ``` ### -AllowVoicemail + +> Applicable: Microsoft Teams + Enables inbound calls to be routed to voicemail. Valid options are: @@ -275,7 +284,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -285,13 +293,15 @@ Accept wildcard characters: False ``` ### -AllowWebPSTNCalling + +> Applicable: Microsoft Teams + Allows PSTN calling from the Team web client. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -301,6 +311,9 @@ Accept wildcard characters: False ``` ### -AutoAnswerEnabledType + +> Applicable: Microsoft Teams + Setting this parameter allows you to enable or disable auto-answer for incoming meeting invites on Teams Phones. This setting applies only to incoming meeting invites and does not include support for other call types. Valid options are: @@ -312,7 +325,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -322,6 +334,9 @@ Accept wildcard characters: False ``` ### -BusyOnBusyEnabledType + +> Applicable: Microsoft Teams + Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. Valid options are: @@ -335,7 +350,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -345,6 +359,9 @@ Accept wildcard characters: False ``` ### -CallingSpendUserLimit + +> Applicable: Microsoft Teams + The maximum amount a user can spend on outgoing PSTN calls, including all calls made through Pay-as-you-go Calling Plans and any overages on plans with bundled minutes. Possible values: any positive integer @@ -353,7 +370,6 @@ Possible values: any positive integer Type: Long Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -362,13 +378,15 @@ Accept wildcard characters: False ``` ### -CallRecordingExpirationDays + +> Applicable: Microsoft Teams + Sets the expiration of the recorded 1:1 calls. Default is 60 days. ```yaml Type: Long Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -378,13 +396,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -394,6 +414,9 @@ Accept wildcard characters: False ``` ### -Copilot + +> Applicable: Microsoft Teams + Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call. Valid options are: @@ -405,7 +428,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -415,13 +437,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users to whom the policy should be assigned. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -431,6 +455,9 @@ Accept wildcard characters: False ``` ### -EnableSpendLimits + +> Applicable: Microsoft Teams + This setting allows an admin to enable or disable spend limits on PSTN calls for their user base. Possible values: @@ -442,7 +469,6 @@ Possible values: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: False @@ -466,13 +492,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -481,7 +509,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Name of the policy instance being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InboundFederatedCallRoutingTreatment + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound federated calls should be routed. Valid options are: @@ -497,7 +543,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -507,6 +552,9 @@ Accept wildcard characters: False ``` ### -InboundPstnCallRoutingTreatment + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound PSTN calls should be routed. Valid options are: @@ -522,7 +570,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -532,6 +579,9 @@ Accept wildcard characters: False ``` ### -LiveCaptionsEnabledTypeForCalling + +> Applicable: Microsoft Teams + Determines whether real-time captions are available for the user in Teams calls. Valid options are: @@ -543,7 +593,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -553,6 +602,9 @@ Accept wildcard characters: False ``` ### -MusicOnHoldEnabledType + +> Applicable: Microsoft Teams + Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold. Valid options are: @@ -565,7 +617,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -575,13 +626,15 @@ Accept wildcard characters: False ``` ### -PopoutAppPathForIncomingPstnCalls + +> Applicable: Microsoft Teams + Setting this parameter allows you to set the PopoutForIncomingPstnCalls setting's URL path of the website to launch upon receiving incoming PSTN calls. This parameter accepts an HTTPS URL with less than 1024 characters. The URL can contain a `{phone}` placeholder that is replaced with the caller's PSTN number in E.164 format when launched. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: "" @@ -590,13 +643,15 @@ Accept wildcard characters: False ``` ### -PopoutForIncomingPstnCalls + +> Applicable: Microsoft Teams + Setting this parameter allows you to control the tenant users' ability to launch an external website URL automatically in the browser window upon incoming PSTN calls for specific users or user groups. Valid options are Enabled and Disabled. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: Disabled @@ -605,6 +660,9 @@ Accept wildcard characters: False ``` ### -PreventTollBypass + +> Applicable: Microsoft Teams + Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. > [!NOTE] @@ -614,7 +672,6 @@ Setting this parameter to True will send calls through PSTN and incur charges ra Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -623,77 +680,85 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpamFilteringEnabledType -Determines Spam filtering mode. +### -RealTimeText -Possible values: +> Applicable: Microsoft Teams -- Enabled: Spam Filtering is fully enabled. Both Basic and Captcha Interactive Voice Response (IVR) checks are performed. In case the call is considered spam, the user will get a "Spam Likely" notification in Teams. -- Disabled: Spam Filtering is completely disabled. No checks are performed. A "Spam Likely" notification will not appear. -- EnabledWithoutIVR: Spam Filtering is partially enabled. Captcha IVR checks are disabled. A "Spam Likely" notification will appear. A call might get dropped if it gets a high score from Basic checks. +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceSimulationInInterpreter +### -SpamFilteringEnabledType ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. +> Applicable: Microsoft Teams -Enables the user to use the voice simulation feature while being AI interpreted. +Determines Spam filtering mode. -Possible Values: +Possible values: -- Disabled -- Enabled +- Enabled: Spam Filtering is fully enabled. Both Basic and Captcha Interactive Voice Response (IVR) checks are performed. In case the call is considered spam, the user will get a "Spam Likely" notification in Teams. +- Disabled: Spam Filtering is completely disabled. No checks are performed. A "Spam Likely" notification will not appear. +- EnabledWithoutIVR: Spam Filtering is partially enabled. Captcha IVR checks are disabled. A "Spam Likely" notification will appear. A call might get dropped if it gets a high score from Basic checks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeText +### -VoiceSimulationInInterpreter + +> Applicable: Microsoft Teams + >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. -Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. +Enables the user to use the voice simulation feature while being AI interpreted. Possible Values: -- Enabled: User is allowed to turn on real time text. -- Disabled: User is not allowed to turn on real time text. + +- Disabled +- Enabled ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: Enabled +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -701,7 +766,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsChannelsPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsChannelsPolicy.md index fd19f2ca12..bb4e871109 100644 --- a/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsChannelsPolicy.md @@ -1,9 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-csteamschannelspolicy -applicable: Microsoft Teams -title: New-CsTeamsChannelsPolicy schema: 2.0.0 +title: New-CsTeamsChannelsPolicy --- # New-CsTeamsChannelsPolicy @@ -36,8 +38,8 @@ This example shows creating a new policy with name "StudentPolicy" where Private ## PARAMETERS -### -EnablePrivateTeamDiscovery -Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. +### -AllowChannelSharingToExternalUser +Owners of a shared channel can invite external users to join the channel if Microsoft Entra external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml Type: Boolean @@ -51,13 +53,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowOrgWideTeamCreation +Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -66,10 +68,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Bypasses all non-fatal errors. +### -AllowPrivateChannelCreation +Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -80,26 +83,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy that you are creating. +### -AllowSharedChannelCreation +Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. ```yaml -Type: String -Parameter Sets: Identity +Type: Boolean +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -AllowUserToParticipateInExternalSharedChannel +Users and teams can be invited to external shared channels if Microsoft Entra external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml -Type: System.Guid +Type: Boolean Parameter Sets: (All) Aliases: @@ -110,13 +113,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -125,11 +128,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOrgWideTeamCreation -Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. +### -Description +Specifies the description of the policy. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -140,8 +143,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateChannelCreation -Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. +### -EnablePrivateTeamDiscovery +Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml Type: Boolean @@ -155,11 +158,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelSharingToExternalUser -Owners of a shared channel can invite external users to join the channel if Microsoft Entra external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). - +### -Force +Bypasses all non-fatal errors. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -170,26 +172,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedChannelCreation -Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. +### -Identity +Specify the name of the policy that you are creating. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserToParticipateInExternalSharedChannel -Users and teams can be invited to external shared channels if Microsoft Entra external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). +### -Tenant +Internal Microsoft use only. ```yaml -Type: Boolean +Type: System.Guid Parameter Sets: (All) Aliases: @@ -219,13 +221,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Specifies the description of the policy. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication.md index a08b36dfb9..cf2df57862 100644 --- a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication applicable: Microsoft Teams -title: New-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication +schema: 2.0.0 +title: New-CsTeamsComplianceRecordingApplication --- # New-CsTeamsComplianceRecordingApplication @@ -110,193 +111,161 @@ Please refer to the documentation of the ComplianceRecordingPairedApplications p ## PARAMETERS -### -Identity -A name that uniquely identifies the application instance of the policy-based recording application. +### -ComplianceRecordingPairedApplications +Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. -Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -To do this association correctly, the Identity of these application instances must be \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. +In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. -### -Parent -The Identity of the Teams recording policy that this application instance of a policy-based recording application is associated with. -For example, the Parent of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy\", which indicates that the application instance is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey +Type: ComplianceRecordingPairedApplication[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Id -The ObjectId of the application instance of a policy-based recording application as exposed by the Get-CsOnlineApplicationInstance cmdlet. -For example, the Id of an application instance can be \"39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance has ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. +### -ConcurrentInvitationCount +Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: +In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. -### -RequiredBeforeMeetingJoin -Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. -If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. -The meeting will still continue for users who are in the meeting. +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. -If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: 1 Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredDuringMeeting -Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. - -If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. -The meeting will still continue for users who are in the meeting. - -If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredBeforeCallEstablishment -Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. - -If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. - -If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredDuringCall -Indicates whether the policy-based recording application must be in the call while the call is active. - -If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. - -If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. +### -Id +The ObjectId of the application instance of a policy-based recording application as exposed by the Get-CsOnlineApplicationInstance cmdlet. +For example, the Id of an application instance can be \"39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance has ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: String +Parameter Sets: ParentAndRelativeKey Aliases: -Required: False +Required: True Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentInvitationCount -Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. - -In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. +Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +To do this association correctly, the Identity of these application instances must be \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. +### -InMemory +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingPairedApplications -Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. - -In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. - -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. - -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. +### -Parent +The Identity of the Teams recording policy that this application instance of a policy-based recording application is associated with. +For example, the Parent of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy\", which indicates that the application instance is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. ```yaml -Type: ComplianceRecordingPairedApplication[] -Parameter Sets: (All) +Type: String +Parameter Sets: ParentAndRelativeKey Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -321,68 +290,100 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: +### -RequiredBeforeCallEstablishment +Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. -You can return your tenant ID by running this command: +If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. -Get-CsTenant | Select-Object DisplayName, TenantID +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeMeetingJoin +Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. + +If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. ```yaml -Type: System.Guid +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -RequiredDuringCall +Indicates whether the policy-based recording application must be in the call while the call is active. + +If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. + +If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -RequiredDuringMeeting +Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. + +If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication.md index d444f6ae79..e62f303b70 100644 --- a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPairedApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication applicable: Microsoft Teams -title: New-CsTeamsComplianceRecordingPairedApplication -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication +schema: 2.0.0 +title: New-CsTeamsComplianceRecordingPairedApplication --- # New-CsTeamsComplianceRecordingPairedApplication diff --git a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy.md index e1caae78f9..e1f38b80c2 100644 --- a/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsComplianceRecordingPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy applicable: Microsoft Teams -title: New-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: New-CsTeamsComplianceRecordingPolicy --- # New-CsTeamsComplianceRecordingPolicy @@ -64,38 +66,36 @@ Any Microsoft Teams users who are assigned this policy will have their calls and ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new Teams recording policy. +### -ComplianceRecordingApplications +A list of application instances of policy-based recording applications to assign to this policy. +The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. -Use the "Global" Identity if you wish to assign this policy to the entire tenant. +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. ```yaml -Type: XdsIdentity +Type: ComplianceRecordingApplication[] Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Controls whether this Teams recording policy is active or not. - -Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. - -Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -115,8 +115,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WarnUserOnRemoval -This parameter is reserved for future use. +### -CustomPromptsEnabled +Indicates whether compliance recording custom prompts feature is enabled for this tenant / user. ```yaml Type: Boolean @@ -125,13 +125,13 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. +### -CustomPromptsPackageId +Reference to custom prompts package. ```yaml Type: String @@ -145,15 +145,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingApplications -A list of application instances of policy-based recording applications to assign to this policy. -The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +### -Description +Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: ComplianceRecordingApplication[] +Type: String Parameter Sets: (All) Aliases: @@ -179,8 +175,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RecordReroutedCalls -Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. +### -Enabled +Controls whether this Teams recording policy is active or not. + +Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. ```yaml Type: Boolean @@ -194,22 +194,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -220,23 +209,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier to be assigned to the new Teams recording policy. + +Use the "Global" Identity if you wish to assign this policy to the entire tenant. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -InMemory +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter @@ -250,27 +242,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +### -RecordReroutedCalls +Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomPromptsEnabled -Indicates whether compliance recording custom prompts feature is enabled for this tenant / user. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: Boolean +Type: System.Guid Parameter Sets: (All) Aliases: @@ -281,17 +283,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomPromptsPackageId -Reference to custom prompts package. +### -WarnUserOnRemoval +This parameter is reserved for future use. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCortanaPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCortanaPolicy.md index 247ea3b3a6..0e1bcdb299 100644 --- a/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy applicable: Microsoft Teams -title: New-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +schema: 2.0.0 +title: New-CsTeamsCortanaPolicy --- # New-CsTeamsCortanaPolicy diff --git a/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCustomBannerText.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsCustomBannerText.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsCustomBannerText.md index 4ed97c99b6..ec012c5bd9 100644 --- a/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsCustomBannerText.md @@ -1,10 +1,11 @@ --- +author: saleens7 +Locale: en-US Module Name: MicrosoftTeams +ms.author: wblocker online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext -title: New-CsTeamsCustomBannerText schema: 2.0.0 -author: saleens7 -ms.author: wblocker +title: New-CsTeamsCustomBannerText --- # New-CsTeamsCustomBannerText @@ -36,14 +37,27 @@ This example creates an instance of TeamsCustomBannerText with the name CustomTe ## PARAMETERS +### -Description +The description that the global admin would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id + +> Applicable: Microsoft Teams + The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. ```yaml Type: Guid Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -62,17 +76,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -The description that the global admin would like to set to identify what this text represents. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy.md index 0cc06eb366..9960631e83 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: New-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manger: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc, vaddank +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: New-CsTeamsEmergencyCallRoutingPolicy --- # New-CsTeamsEmergencyCallRoutingPolicy @@ -46,28 +48,28 @@ This example overrides the global emergency numbers from the global instance. ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the name of the policy. +### -AllowEnhancedEmergencyServices +Flag to enable Enhanced Emergency Services. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEnhancedEmergencyServices -Flag to enable Enhanced Emergency Services. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -106,29 +108,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity +The Identity parameter is a unique identifier that designates the name of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification.md index 693ea5b9cd..199f0e0c46 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification applicable: Microsoft Teams -title: New-CsTeamsEmergencyCallingExtendedNotification author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification schema: 2.0.0 +title: New-CsTeamsEmergencyCallingExtendedNotification --- # New-CsTeamsEmergencyCallingExtendedNotification @@ -50,8 +51,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationGroup -NotificationGroup is an email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 entries consisting of users and/or groups can be added to the NotificationGroup. The total number of users notified cannot exceed 50. +### -NotificationDialOutNumber +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. ```yaml Type: String @@ -65,8 +66,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationDialOutNumber -This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. +### -NotificationGroup +NotificationGroup is an email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 entries consisting of users and/or groups can be added to the NotificationGroup. The total number of users notified cannot exceed 50. ```yaml Type: String diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy.md index 60f9db0fb7..c49ab79175 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: New-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy schema: 2.0.0 +title: New-CsTeamsEmergencyCallingPolicy --- # New-CsTeamsEmergencyCallingPolicy @@ -60,16 +62,16 @@ New-CsTeamsEmergencyCallingPolicy -Identity ECP2 -Description "Test ECP2" -Exter ## PARAMETERS -### -Identity - The Identity parameter is a unique identifier that designates the name of the policy +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -139,6 +141,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + The Identity parameter is a unique identifier that designates the name of the policy + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NotificationDialOutNumber This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. @@ -202,21 +219,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyNumber.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyNumber.md index 9d89a4ced3..86411b77be 100644 --- a/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEmergencyNumber.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber applicable: Microsoft Teams -title: New-CsTeamsEmergencyNumber author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc, pthota +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber schema: 2.0.0 +title: New-CsTeamsEmergencyNumber --- # New-CsTeamsEmergencyNumber diff --git a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEnhancedEncryptionPolicy.md similarity index 96% rename from teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEnhancedEncryptionPolicy.md index 94d8089d7a..2654e75940 100644 --- a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEnhancedEncryptionPolicy.md @@ -1,189 +1,190 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy -title: New-CsTeamsEnhancedEncryptionPolicy -author: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# New-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Use this cmdlet to create a new Teams enhanced encryption policy. - -## SYNTAX - -``` -New-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] - [[-Identity] ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Use this cmdlet to create a new Teams enhanced encryption policy. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -``` - -Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the default values to its settings. - -### EXAMPLE 2 -```PowerShell -PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -MeetingEndToEndEncryption DisabledUserOverride -``` - -Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the provided values to its settings. - -## PARAMETERS - -### -Description -Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. - -For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallingEndtoEndEncryptionEnabledType -Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingEndToEndEncryption -Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling Set-CsTeamsEnhancedEncryptionPolicy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses all non-fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: New-CsTeamsEnhancedEncryptionPolicy +--- + +# New-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Use this cmdlet to create a new Teams enhanced encryption policy. + +## SYNTAX + +``` +New-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] + [[-Identity] ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Use this cmdlet to create a new Teams enhanced encryption policy. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy +``` + +Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the default values to its settings. + +### EXAMPLE 2 +```PowerShell +PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -MeetingEndToEndEncryption DisabledUserOverride +``` + +Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the provided values to its settings. + +## PARAMETERS + +### -CallingEndtoEndEncryptionEnabledType +Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. + +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling Set-CsTeamsEnhancedEncryptionPolicy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingEndToEndEncryption +Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEventsPolicy.md similarity index 96% rename from teams/teams-ps/teams/New-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsEventsPolicy.md index a584eb4601..119c029d77 100644 --- a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsEventsPolicy.md @@ -1,408 +1,409 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamseventspolicy -title: New-CsTeamsEventsPolicy -schema: 2.0.0 -ms.date: 04/23/2025 ---- - -# New-CsTeamsEventsPolicy - -## SYNOPSIS -This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. - -## SYNTAX - -```powershell -New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-AllowTownhalls ] [-ImmersiveEvents ] [-AllowEmailEditing ] [-Description ] -[-TownhallEventAttendeeAccess ] [-RecordingForTownhall ] [-RecordingForWebinar ] -[-TranscriptionForTownhall ] [-TranscriptionForWebinar ] [-AllowEventIntegrations ] [-TownhallChatExperience ] -[-UseMicrosoftECDN ] [-EventAccessType ] [-BroadcastPremiumApps ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsEventsPolicy -Identity DisablePublicWebinars -AllowWebinars Enabled -EventAccessType EveryoneInCompanyExcludingGuests -``` - -The command shown in Example 1 creates a new per-user Teams Events policy with the Identity DisablePublicWebinars. This policy disables a user from creating public webinars. - -### Example 2 -```powershell -PS C:\> New-CsTeamsEventsPolicy -Identity DisableWebinars -AllowWebinars Disabled -``` - -The command shown in Example 2 creates a new per-user Teams Events policy with the Identity DisableWebinars. This policy disables a user from creating webinars. - -## PARAMETERS - -### -AllowWebinars -This setting governs if a user can create webinars using Teams Events. -Possible values are: - - **Enabled**: Enables creating webinars. - - **Disabled**: Disables creating webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseMicrosoftECDN -This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTownhalls -This setting governs if a user can create town halls using Teams Events. -Possible values are: - - **Enabled**: Enables creating town halls. - - **Disabled**: Disables creating town hall. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmersiveEvents -This setting governs if a user can create Immersive Events using Teams Events. -Possible values are: - - **Enabled**: Enables creating Immersive Events. - - **Disabled**: Disables creating Immersive Events. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TownhallEventAttendeeAccess -This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. -Possible values are: - - **Everyone**: Anyone with the join link may enter the event. - - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Everyone -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEmailEditing -This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. -Possible values are: - - **Enabled**: Enables editing of communication emails. - - **Disabled**: Disables editing of communication emails. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventAccessType -This setting governs which users can access the Town hall event and access the event registration page or the event site to register for a Webinar. It also governs which user type is allowed to join the session or sessions in the event for both event types. - -Possible values are: - - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - - - **EveryoneInCompanyExcludingGuests**: For Webinar - enables creating events to allow only in-tenant users to register and join the event. For Town hall - enables creating events to allow only in-tenant users to join the event (Note: for Town hall, in-tenant users include guests; this parameter will disable public Town halls). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Everyone -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedQuestionTypesInRegistrationForm -This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. - -Possible values are: DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedTownhallTypesForRecordingPublish -This setting governs which types of town halls can have their recordings published. - -Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedWebinarTypesForRecordingPublish -This setting governs which types of webinars can have their recordings published. - -Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordingForTownhall -Determines whether recording is allowed in a user's townhall. -Possible values are: - - **Enabled**: Allow recording in user's townhalls. - - **Disabled**: Prohibit recording in user's townhalls. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` -### -RecordingForWebinar -Determines whether recording is allowed in a user's webinar. -Possible values are: - - **Enabled**: Allow recording in user's webinars. - - **Disabled**: Prohibit recording in user's webinars. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` -### -TranscriptionForTownhall -Determines whether transcriptions are allowed in a user's townhall. -Possible values are: - - **Enabled**: Allow transcriptions in user's townhalls. - - **Disabled**: Prohibit transcriptions in user's townhalls. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` -### -TranscriptionForWebinar -Determines whether transcriptions are allowed in a user's webinar. -Possible values are: - - **Enabled**: Allow transcriptions in user's webinars. - - **Disabled**: Prohibit transcriptions in user's webinars. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEventIntegrations -This setting governs the access to the integrations tab in the event creation workflow. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TownhallChatExperience -This setting governs if the user can enable the Comment Stream chat experience for Townhalls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BroadcastPremiumApps -This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. - -Possible values are: -- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall -- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch does not work with this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch does not work with this cmdlet. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.date: 04/23/2025 +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamseventspolicy +schema: 2.0.0 +title: New-CsTeamsEventsPolicy +--- + +# New-CsTeamsEventsPolicy + +## SYNOPSIS +This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. + +## SYNTAX + +```powershell +New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-AllowTownhalls ] [-ImmersiveEvents ] [-AllowEmailEditing ] [-Description ] +[-TownhallEventAttendeeAccess ] [-RecordingForTownhall ] [-RecordingForWebinar ] +[-TranscriptionForTownhall ] [-TranscriptionForWebinar ] [-AllowEventIntegrations ] [-TownhallChatExperience ] +[-UseMicrosoftECDN ] [-EventAccessType ] [-BroadcastPremiumApps ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsEventsPolicy -Identity DisablePublicWebinars -AllowWebinars Enabled -EventAccessType EveryoneInCompanyExcludingGuests +``` + +The command shown in Example 1 creates a new per-user Teams Events policy with the Identity DisablePublicWebinars. This policy disables a user from creating public webinars. + +### Example 2 +```powershell +PS C:\> New-CsTeamsEventsPolicy -Identity DisableWebinars -AllowWebinars Disabled +``` + +The command shown in Example 2 creates a new per-user Teams Events policy with the Identity DisableWebinars. This policy disables a user from creating webinars. + +## PARAMETERS + +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. + +Possible values are: DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTownhallTypesForRecordingPublish +This setting governs which types of town halls can have their recordings published. + +Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedWebinarTypesForRecordingPublish +This setting governs which types of webinars can have their recordings published. + +Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailEditing +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. +Possible values are: + - **Enabled**: Enables editing of communication emails. + - **Disabled**: Disables editing of communication emails. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEventIntegrations +This setting governs the access to the integrations tab in the event creation workflow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTownhalls +This setting governs if a user can create town halls using Teams Events. +Possible values are: + - **Enabled**: Enables creating town halls. + - **Disabled**: Disables creating town hall. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWebinars +This setting governs if a user can create webinars using Teams Events. +Possible values are: + - **Enabled**: Enables creating webinars. + - **Disabled**: Disables creating webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastPremiumApps +This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. + +Possible values are: +- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall +- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventAccessType +This setting governs which users can access the Town hall event and access the event registration page or the event site to register for a Webinar. It also governs which user type is allowed to join the session or sessions in the event for both event types. + +Possible values are: + - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + + - **EveryoneInCompanyExcludingGuests**: For Webinar - enables creating events to allow only in-tenant users to register and join the event. For Town hall - enables creating events to allow only in-tenant users to join the event (Note: for Town hall, in-tenant users include guests; this parameter will disable public Town halls). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmersiveEvents +This setting governs if a user can create Immersive Events using Teams Events. +Possible values are: + - **Enabled**: Enables creating Immersive Events. + - **Disabled**: Disables creating Immersive Events. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForTownhall +Determines whether recording is allowed in a user's townhall. +Possible values are: + - **Enabled**: Allow recording in user's townhalls. + - **Disabled**: Prohibit recording in user's townhalls. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -RecordingForWebinar +Determines whether recording is allowed in a user's webinar. +Possible values are: + - **Enabled**: Allow recording in user's webinars. + - **Disabled**: Prohibit recording in user's webinars. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -TownhallChatExperience +This setting governs if the user can enable the Comment Stream chat experience for Townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallEventAttendeeAccess +This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. +Possible values are: + - **Everyone**: Anyone with the join link may enter the event. + - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranscriptionForTownhall +Determines whether transcriptions are allowed in a user's townhall. +Possible values are: + - **Enabled**: Allow transcriptions in user's townhalls. + - **Disabled**: Prohibit transcriptions in user's townhalls. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -TranscriptionForWebinar +Determines whether transcriptions are allowed in a user's webinar. +Possible values are: + - **Enabled**: Allow transcriptions in user's webinars. + - **Disabled**: Prohibit transcriptions in user's webinars. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMicrosoftECDN +This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch does not work with this cmdlet. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFeedbackPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsFeedbackPolicy.md index 97eb4b84ce..9446d64314 100644 --- a/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFeedbackPolicy.md @@ -1,9 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsfeedbackpolicy -applicable: Microsoft Teams -title: New-CsTeamsFeedbackPolicy schema: 2.0.0 +title: New-CsTeamsFeedbackPolicy --- # New-CsTeamsFeedbackPolicy @@ -33,14 +35,13 @@ In this example, we create a feedback policy called New Hire Feedback Policy and ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowEmailCollection +Set this to TRUE to enable Email collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf - +Aliases: Required: False Position: Named Default value: None @@ -48,14 +49,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppress all non-fatal errors. +### -AllowLogCollection +Set this to TRUE to enable log collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -63,28 +63,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -A unique identifier. +### -AllowScreenshotCollection +Set this to TRUE to enable Screenshot collection. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: - Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -The InMemory parameter creates an object reference without actually committing the object as a permanent change. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -93,31 +92,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiveSurveysMode -Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. - -Possible values: - - Enabled - - Disabled - - EnabledUserOverride +### -EnableFeatureSuggestions + This setting will enable Tenant Admins to hide or show the Teams menu item “Help | Suggest a Feature”. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -Force +Suppress all non-fatal errors. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -128,33 +122,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserInitiatedMode - Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. - Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. - - Possible values: - - Enabled - - Disabled +### -Identity +A unique identifier. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: Enabled +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEmailCollection -Set this to TRUE to enable Email collection. +### -InMemory +The InMemory parameter creates an object reference without actually committing the object as a permanent change. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -162,27 +152,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowLogCollection -Set this to TRUE to enable log collection. +### -ReceiveSurveysMode +Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. + +Possible values: + - Enabled + - Disabled + - EnabledUserOverride ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: + Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowScreenshotCollection -Set this to TRUE to enable Screenshot collection. +### -Tenant +Internal Microsoft use only. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -190,17 +187,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFeatureSuggestions - This setting will enable Tenant Admins to hide or show the Teams menu item “Help | Suggest a Feature”. +### -UserInitiatedMode + Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. + Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. + + Possible values: + - Enabled + - Disabled ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFilesPolicy.md similarity index 96% rename from teams/teams-ps/teams/New-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsFilesPolicy.md index 96097f3869..f1e4ecfb5a 100644 --- a/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsFilesPolicy.md @@ -1,21 +1,20 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy -title: New-CsTeamsFilesPolicy schema: 2.0.0 +title: New-CsTeamsFilesPolicy --- # New-CsTeamsFilesPolicy ## SYNOPSIS Creates a new teams files policy. -teams files policies determine whether or not files entry points to sharepoint enabled for a user. -The policies also specify third party app id to allow file storage(eg. Box). ## SYNTAX -```powershell +``` New-CsTeamsFilesPolicy [-NativeFileEntryPoints ] [-SPChannelFilesTab ] [-DefaultFileUploadAppId ] [-FileSharingInChatswithExternalUsers ] [-AutoShareFilesInExternalChats ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] @@ -36,24 +35,25 @@ The command shown in Example 1 creates a per-user teams files policy CustomTeams ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -AutoShareFilesInExternalChats + +Indicates if file scope will be changed automatically when sharing files and loops in chats with external or guest users. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NativeFileEntryPoints -This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . -Possible values are Enabled or Disabled. +### -DefaultFileUploadAppId +This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. + ```yaml Type: String Parameter Sets: (All) @@ -64,11 +64,11 @@ Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False - ``` -### -DefaultFileUploadAppId -This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. ```yaml Type: String @@ -98,26 +98,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileSharingInChatswithExternalUsers - -Indicates if file sharing in chats with external users is enabled. +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoShareFilesInExternalChats - -Indicates if file scope will be changed automatically when sharing files and loops in chats with external or guest users. - +### -NativeFileEntryPoints +This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . +Possible values are Enabled or Disabled. ```yaml Type: String Parameter Sets: (All) @@ -128,6 +126,7 @@ Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False + ``` ### -SPChannelFilesTab diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenMeetingTemplate.md similarity index 74% rename from teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenMeetingTemplate.md index afae69de7e..a900dd6997 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenMeetingTemplate.md @@ -1,17 +1,18 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: New-CsTeamsHiddenMeetingTemplate -author: boboPD ms.author: pradas online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsHiddenMeetingTemplate schema: 2.0.0 +title: New-CsTeamsHiddenMeetingTemplate --- # New-CsTeamsHiddenMeetingTemplate ## SYNOPSIS -This cmdlet is used to create a `HiddenMeetingTemplate` object for use with the [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) and [Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) cmdlets. +This cmdlet is used to create a `HiddenMeetingTemplate` object. ## SYNTAX @@ -21,7 +22,9 @@ New-CsTeamsHiddenMeetingTemplate -Id [] ## DESCRIPTION -Creates an object that can be supplied as `HiddenMeetingTemplate` to the [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) and [Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) cmdlets. +Creates an object that can be supplied as `HiddenMeetingTemplate` to the +[New-CsTeamsMeetingTemplatePermissionPolicy](new-csteamsmeetingtemplatepermissionpolicy.md) and +[Set-CsTeamsMeetingTemplatePermissionPolicy](set-csteamsmeetingtemplatepermissionpolicy.md) cmdlets. ## EXAMPLES @@ -41,13 +44,14 @@ For more examples of how this can be used, see the examples for [New-CsTeamsMeet ### -Id +> Applicable: Microsoft Teams + ID of the meeting template to hide. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenTemplate.md similarity index 72% rename from teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenTemplate.md index 5df0f7b450..a76554a5cc 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsHiddenTemplate.md @@ -1,20 +1,19 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate -title: New-CsTeamsHiddenTemplate author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate schema: 2.0.0 +title: New-CsTeamsHiddenTemplate --- # New-CsTeamsHiddenTemplate ## SYNOPSIS -This cmdlet is used to create a `HiddenTemplate` object for use with the [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) and [Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) cmdlets. - +This cmdlet is used to create a `HiddenTemplate` object. ## SYNTAX ``` @@ -22,7 +21,7 @@ New-CsTeamsHiddenTemplate -Id [] ``` ## DESCRIPTION -Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) and [Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) cmdlets. +Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTemplatePermissionPolicy](new-csteamstemplatepermissionpolicy.md) and [Set-CsTeamsTemplatePermissionPolicy](set-csteamstemplatepermissionpolicy.md) cmdlets. ## EXAMPLES diff --git a/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsIPPhonePolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsIPPhonePolicy.md index 93cdfa7a78..979614ce08 100644 --- a/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsipphonepolicy applicable: Microsoft Teams -title: New-CsTeamsIPPhonePolicy author: tonywoodruff +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsipphonepolicy schema: 2.0.0 +title: New-CsTeamsIPPhonePolicy --- # New-CsTeamsIPPhonePolicy @@ -50,21 +51,6 @@ This example shows a new policy being created called "CommonAreaPhone" setting t ## PARAMETERS -### -Identity -The identity of the policy that you want to create. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowBetterTogether Determines whether Better Together mode is enabled, phones can lock and unlock in an integrated fashion when connected to their Windows PC running a 64-bit Teams desktop client. Possible values this parameter can take: @@ -179,6 +165,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +The identity of the policy that you want to create. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SearchOnCommonAreaPhoneMode Determines whether a user can search the Global Address List in Common Area Phone Mode. Set this to ENABLED to enable the feature. Set this to DISABLED to disable the feature. diff --git a/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMediaConnectivityPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMediaConnectivityPolicy.md index 3f141907b4..bda748ef17 100644 --- a/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: lirunping-MSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: New-CsTeamsMediaConnectivityPolicy +ms.author: runli online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMediaConnectivityPolicy schema: 2.0.0 -author: lirunping-MSFT -ms.author: runli +title: New-CsTeamsMediaConnectivityPolicy --- # New-CsTeamsMediaConnectivityPolicy @@ -38,30 +39,30 @@ The newly created policy with value will be printed on success. ## PARAMETERS -### -Identity -Identity of the Teams media connectivity policy. +### -DirectConnection +This setting will enable Tenant Admins to control the Teams media connectivity behavior in Teams for both Meetings and 1:1 calls. If this setting is set to true, a direct media connection between the current user and a remote user is allowed which may improve the meeting quality and reduce the egress bandwidth usage for the customer. If this setting is set to disabled, no direct media connection will be allowed for the current user. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DirectConnection -This setting will enable Tenant Admins to control the Teams media connectivity behavior in Teams for both Meetings and 1:1 calls. If this setting is set to true, a direct media connection between the current user and a remote user is allowed which may improve the meeting quality and reduce the egress bandwidth usage for the customer. If this setting is set to disabled, no direct media connection will be allowed for the current user. +### -Identity +Identity of the Teams media connectivity policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy.md index 6a2c7ee7cd..885c495cfd 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy schema: 2.0.0 title: New-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # New-CsTeamsMeetingBrandingPolicy @@ -43,14 +43,13 @@ In this example, the command will create an empty meeting branding policy with t ## PARAMETERS -### -DefaultTheme -*This parameter is reserved for Microsoft internal use only.* -Identity of default meeting theme. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -59,11 +58,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingBackgroundImages -Enable custom meeting backgrounds. +### -DefaultTheme +*This parameter is reserved for Microsoft internal use only.* +Identity of default meeting theme. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -74,8 +74,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingOptionsThemeOverride -Allow organizer to control meeting theme. +### -EnableMeetingBackgroundImages +Enable custom meeting backgrounds. ```yaml Type: Boolean @@ -89,28 +89,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Identity of meeting branding policy that will be created. +### -EnableMeetingOptionsThemeOverride +Allow organizer to control meeting theme. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingBackgroundImages -*This parameter is reserved for Microsoft internal use only.* -List of meeting background images. -Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. +### -EnableNdiAssuranceSlate +This enables meeting Network Device Interface Assurance Slate branding. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) Aliases: @@ -121,13 +119,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingBrandingThemes -*This parameter is reserved for Microsoft internal use only.* -List of meeting branding themes. -Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -138,26 +134,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNdiAssuranceSlate -This enables meeting Network Device Interface Assurance Slate branding. +### -Identity +Identity of meeting branding policy that will be created. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NdiAssuranceSlateImages -Used to specify images that can be used as assurance slates during NDI (Network Device Interface) streaming in Teams meetings. This parameter allows administrators to define a set of images that can be displayed to participants to ensure that the NDI stream is functioning correctly. +### -MeetingBackgroundImages +*This parameter is reserved for Microsoft internal use only.* +List of meeting background images. +Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.NdiAssuranceSlate] +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -168,11 +166,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireBackgroundEffect -This mandates a meeting background for participants. +### -MeetingBrandingThemes +*This parameter is reserved for Microsoft internal use only.* +List of meeting branding themes. +Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) Aliases: @@ -183,13 +183,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NdiAssuranceSlateImages +Used to specify images that can be used as assurance slates during NDI (Network Device Interface) streaming in Teams meetings. This parameter allows administrators to define a set of images that can be displayed to participants to ensure that the NDI stream is functioning correctly. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.NdiAssuranceSlate] Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -198,11 +198,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -RequireBackgroundEffect +This mandates a meeting background for participants. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy.md similarity index 92% rename from teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy.md index 898cfcd848..203bbda294 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingBroadcastPolicy.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbroadcastpolicy applicable: Microsoft Teams -title: New-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: New-CsTeamsMeetingBroadcastPolicy --- # New-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS - -New-CsTeamsMeetingBroadcastPolicy \[-Identity\] \ \[-Tenant \\] \[-Description \\] \[-AllowBroadcastScheduling \\] \[-AllowBroadcastTranscription \\] \[-BroadcastAttendeeVisibilityMode \\] \[-BroadcastRecordingMode \\] \[-InMemory\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] +Use this cmdlet to create a new policy. ## SYNTAX @@ -26,7 +27,7 @@ New-CsTeamsMeetingBroadcastPolicy [-Tenant ] [-Description ] ``` ## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to create a new policy. +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## EXAMPLES diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingPolicy.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingPolicy.md index 531907c565..7610cbe1eb 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingPolicy.md @@ -1,23 +1,24 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingpolicy -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: New-CsTeamsMeetingPolicy -schema: 2.0.0 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.date: 02/26/2025 ms.reviewer: alejandramu -ms.date: 2/26/2025 +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingpolicy +schema: 2.0.0 +title: New-CsTeamsMeetingPolicy --- # New-CsTeamsMeetingPolicy ## SYNOPSIS - The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. +The New-CsTeamsMeetingPolicy cmdlet allows administrators to define new meeting policies that can be assigned to particular users to control Teams features related to meetings. ## SYNTAX -```powershell +``` New-CsTeamsMeetingPolicy [-Identity] [-AIInterpreter ] [-AllowAnonymousUsersToDialOut ] @@ -130,10 +131,9 @@ New-CsTeamsMeetingPolicy [-Identity] ## DESCRIPTION The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. -The New-CsTeamsMeetingPolicy cmdlet allows administrators to define new meeting policies that can be assigned to particular users to control Teams features related to meetings. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $True ``` @@ -141,7 +141,7 @@ New-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $True The command shown in Example 1 uses the New-CsTeamsMeetingPolicy cmdlet to create a new meeting policy with the Identity SalesMeetingPolicy. This policy will use all the default values for a meeting policy except one: AllowTranscription; in this example, meetings for users with this policy can include real time or post meeting captions and transcriptions. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsTeamsMeetingPolicy -Identity HrMeetingPolicy -AutoAdmittedUsers "Everyone" -AllowMeetNow $False ``` @@ -152,22 +152,10 @@ All other policy properties will use the default values. ## PARAMETERS -### -Identity -Specify the name of the policy being created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -182,7 +170,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -191,11 +178,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsersToDialOut -Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to #prohibit anonymous users from dialing out. - -> [!NOTE] -> This parameter is temporarily disabled. +### -AllowAnnotations +This setting will allow admins to choose which users will be able to use the Annotation feature. ```yaml Type: Boolean @@ -209,12 +193,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsersToJoinMeeting +### -AllowAnonymousUsersToDialOut +Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to #prohibit anonymous users from dialing out. > [!NOTE] -> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check for details. - -Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting. +> This parameter is temporarily disabled. ```yaml Type: Boolean @@ -223,13 +206,17 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsersToStartMeeting -Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting +### -AllowAnonymousUsersToJoinMeeting + +> [!NOTE] +> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check for details. + +Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting. ```yaml Type: Boolean @@ -238,13 +225,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnnotations -This setting will allow admins to choose which users will be able to use the Annotation feature. +### -AllowAnonymousUsersToStartMeeting +Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting ```yaml Type: Boolean @@ -373,6 +360,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. + +Possible values are: + +- \ +- RTMP + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowedUsersForMeetingContext This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. @@ -389,6 +395,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowedUsersForMeetingDetails +Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. + +Possible Values: +- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. +- Everyone: All meeting participants can see the meeting info details. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: UsersAllowedToByPassTheLobby +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowEngagementReport Determines whether users are allowed to download the attendee engagement report. Set this to Enabled to allow the user to download the report. Set this to Disabled to prohibit the user to download it. ForceEnabled will enable attendee report generation and prohibit meeting organizer from disabling it. @@ -501,21 +526,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetNow -Determines whether a user can start ad-hoc meetings in a channel. Set this to TRUE to allow a user to start ad-hoc meetings in a channel. Set this to FALSE to prohibit the user from starting ad-hoc meetings in a channel. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: TRUE -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowMeetingCoach This setting will allow admins to allow users the option of turning on Meeting Coach during meetings, which provides users with private personalized feedback on their communication and inclusivity. If set to True, then users will see and be able to click the option for turning on Meeting Coach during calls. If set to False, then users will not have the option to turn on Meeting Coach during calls. @@ -566,6 +576,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowMeetNow +Determines whether a user can start ad-hoc meetings in a channel. Set this to TRUE to allow a user to start ad-hoc meetings in a channel. Set this to FALSE to prohibit the user from starting ad-hoc meetings in a channel. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowNDIStreaming This parameter is reserved for internal Microsoft use. @@ -626,8 +651,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetNow -Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc private meetings. Set this to FALSE to prohibit the user from starting ad-hoc private meetings. +### -AllowParticipantGiveRequestControl +Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting ```yaml Type: Boolean @@ -636,13 +661,13 @@ Aliases: Required: False Position: Named -Default value: TRUE +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowParticipantGiveRequestControl -Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting +### -AllowPowerPointSharing +Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit ```yaml Type: Boolean @@ -656,8 +681,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPowerPointSharing -Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit +### -AllowPrivateMeetingScheduling +Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -671,8 +696,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetingScheduling -Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. +### -AllowPrivateMeetNow +Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc private meetings. Set this to FALSE to prohibit the user from starting ad-hoc private meetings. ```yaml Type: Boolean @@ -681,7 +706,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: TRUE Accept pipeline input: False Accept wildcard characters: False ``` @@ -840,8 +865,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForScreenSharing -This setting allows scheduling meetings with watermarking for screen sharing enabled. +### -AllowWatermarkForCameraVideo +This setting allows scheduling meetings with watermarking for video enabled. ```yaml Type: Boolean @@ -855,8 +880,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForCameraVideo -This setting allows scheduling meetings with watermarking for video enabled. +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermarking for screen sharing enabled. ```yaml Type: Boolean @@ -885,25 +910,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedStreamingMediaInput -Enables the use of RTMP-In in Teams meetings. - -Possible values are: - -- \ -- RTMP - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AnonymousUserAuthenticationMethod Determines how anonymous users will be authenticated when joining a meeting. @@ -1054,18 +1060,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectToMeetingControls -Allows external connections of thirdparty apps to Microsoft Teams - -Possible values are: - -Enabled -Disabled +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -1074,13 +1075,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -ConnectToMeetingControls +Allows external connections of thirdparty apps to Microsoft Teams + +Possible values are: + +Enabled +Disabled ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -1213,7 +1219,7 @@ Accept wildcard characters: False ### -ExplicitRecordingConsent Set participant agreement and notification for Recording, Transcript, Copilot in Teams meetings. -Possible Values: +Possible Values: - Enabled: Explicit consent, requires participant agreement. - Disabled: Implicit consent, does not require participant agreement. @@ -1265,6 +1271,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Specify the name of the policy being created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InfoShownInReportMode This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. @@ -1325,13 +1346,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LiveInterpretationEnabledType -Allows meeting organizers to configure a meeting for language interpretation, selecting attendees of the meeting to become interpreters that other attendees can select and listen to the real-time translation they provide. - -Possible values are: - -DisabledUserOverride, if you would like users to be able to use interpretation in meetings but by default it is disabled. -Disabled, prevents the option to be enabled in Meeting Options. +### -LiveCaptionsEnabledType +Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit. ```yaml Type: String @@ -1345,8 +1361,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LiveCaptionsEnabledType -Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit. +### -LiveInterpretationEnabledType +Allows meeting organizers to configure a meeting for language interpretation, selecting attendees of the meeting to become interpreters that other attendees can select and listen to the real-time translation they provide. + +Possible values are: + +DisabledUserOverride, if you would like users to be able to use interpretation in meetings but by default it is disabled. +Disabled, prevents the option to be enabled in Meeting Options. ```yaml Type: String @@ -1434,6 +1455,9 @@ Accept wildcard characters: False ``` ### -MeetingInviteLanguages + +> Applicable: Microsoft Teams + Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed. > [!NOTE] @@ -1447,7 +1471,6 @@ The preliminary list of available languages is shown below: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1476,6 +1499,8 @@ Accept wildcard characters: False ### -NoiseSuppressionForDialInParticipants +> Applicable: Microsoft Teams + >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1491,7 +1516,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1517,6 +1541,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParticipantSlideControl + +> Applicable: Microsoft Teams + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Determines whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibited from giving control, or being given control, in a meeting. + +Possible Values: +- Everyone: Anyone in the meeting can give or take control +- EveryoneInOrganization: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control +- EveryoneInOrganizationAndGuests: Only those who are Guests to the tenant, MTO users, and internal AAD users can give or take control +- None: No one in the meeting can give or take control + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PreferredMeetingProviderForIslandsMode Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in. @@ -1547,6 +1598,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RealTimeText + +> Applicable: Microsoft Teams + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecordingStorageMode This parameter can take two possible values: @@ -1773,6 +1849,8 @@ Accept wildcard characters: False ### -VoiceSimulationInInterpreter +> Applicable: Microsoft Teams + > [!NOTE] > This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1787,7 +1865,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1871,73 +1948,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedUsersForMeetingDetails -Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. - -Possible Values: -- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. -- Everyone: All meeting participants can see the meeting info details. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: UsersAllowedToByPassTheLobby -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RealTimeText ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. - -Possible Values: -- Enabled: User is allowed to turn on real time text. -- Disabled: User is not allowed to turn on real time text. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParticipantSlideControl ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -Determines whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibited from giving control, or being given control, in a meeting. - -Possible Values: -- Everyone: Anyone in the meeting can give or take control -- EveryoneInOrganization: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control -- EveryoneInOrganizationAndGuests: Only those who are Guests to the tenant, MTO users, and internal AAD users can give or take control -- None: No one in the meeting can give or take control - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 97% rename from teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingTemplatePermissionPolicy.md index 48a5347d44..432bb88db3 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: New-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: New-CsTeamsMeetingTemplatePermissionPolicy --- # New-CsTeamsMeetingTemplatePermissionPolicy @@ -44,15 +45,16 @@ Description : This is a test policy ## PARAMETERS -### -Identity +### -Description -Name of the new policy instance to be created. +> Applicable: Microsoft Teams + +Description of the new policy instance to be created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -62,6 +64,8 @@ Accept wildcard characters: False ### -HiddenMeetingTemplates +> Applicable: Microsoft Teams + The list of meeting template IDs to hide. The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). @@ -69,7 +73,6 @@ The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemp Type: HiddenMeetingTemplate[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -77,15 +80,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Description of the new policy instance to be created. +> Applicable: Microsoft Teams + +Name of the new policy instance to be created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMessagingPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMessagingPolicy.md index f25c5317c1..1d97e21dbc 100644 --- a/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMessagingPolicy.md @@ -1,9 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmessagingpolicy -applicable: Microsoft Teams -title: New-CsTeamsMessagingPolicy schema: 2.0.0 +title: New-CsTeamsMessagingPolicy --- # New-CsTeamsMessagingPolicy @@ -75,20 +77,6 @@ All other policy properties will use the default values. ## PARAMETERS -### -Identity -Unique identifier for the teams messaging policy to be created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` ### -AllowChatWithGroup This setting determines if users can chat with groups (Distribution, M365 and Security groups). Possible values: True, False @@ -648,6 +636,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique identifier for the teams messaging policy to be created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -InMemory Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. diff --git a/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMobilityPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsMobilityPolicy.md index 8bd31ac80b..23b755f08b 100644 --- a/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmobilitypolicy applicable: Microsoft Teams -title: New-CsTeamsMobilityPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmobilitypolicy +schema: 2.0.0 +title: New-CsTeamsMobilityPolicy --- # New-CsTeamsMobilityPolicy @@ -82,6 +84,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Specify the name of the policy that you are creating. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IPAudioMobileMode When set to WifiOnly, prohibits the user from making and receiving calls or joining meetings using VoIP calls on the mobile device while on a cellular data connection. Possible values are: WifiOnly, AllNetworks. @@ -112,16 +129,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy that you are creating. +### -MobileDialerPreference +Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. +For more information, see [Manage user incoming calling policies](https://learn.microsoft.com/microsoftteams/operator-connect-mobile-configure#manage-user-incoming-calling-policies). ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -143,22 +161,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MobileDialerPreference -Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. -For more information, see [Manage user incoming calling policies](https://learn.microsoft.com/microsoftteams/operator-connect-mobile-configure#manage-user-incoming-calling-policies). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy.md index 54b53972d8..e1ec6b688b 100644 --- a/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsnetworkroamingpolicy applicable: Microsoft Teams -title: New-CsTeamsNetworkRoamingPolicy author: TristanChen-msft -ms.author: jiaych -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsnetworkroamingpolicy schema: 2.0.0 +title: New-CsTeamsNetworkRoamingPolicy --- # New-CsTeamsNetworkRoamingPolicy @@ -50,63 +50,63 @@ The command shown in Example 2 creates a new teams network roaming policy with ## PARAMETERS -### -Identity -Unique identifier of the policy to be created. +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. +Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPVideo -Determines whether video is enabled in a user's meetings or calls. -Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. +### -Description +Description of the new policy to be created. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings. +### -Identity +Unique identifier of the policy to be created. ```yaml -Type: Integer +Type: XdsIdentity Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 50000 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the new policy to be created. +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. ```yaml -Type: String +Type: Integer Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: 50000 Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRecordingRollOutPolicy.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsRecordingRollOutPolicy.md index be3f26d1a2..acb2847239 100644 --- a/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- +applicable: Microsoft Teams +author: ronwa external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams +ms.author: ronwa online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsrecordingrolloutpolicy schema: 2.0.0 -applicable: Microsoft Teams title: New-CsTeamsRecordingRollOutPolicy -manager: yujin1 -author: ronwa -ms.author: ronwa --- # New-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsRoomVideoTeleConferencingPolicy.md index ad5c601ece..f90d58cd2d 100644 --- a/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,225 +1,228 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsroomvideoteleconferencingpolicy -title: New-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# New-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Creates a new TeamsRoomVideoTeleConferencingPolicy. - -## SYNTAX - -```powershell -New-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-AreaCode ] [-Description ] - [-Enabled ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] - [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -AreaCode - -GUID provided by the CVI partner that the customer signed the agreement with. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled - -The policy can exist for the tenant but it can be enabled or disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the policy to be modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceExternalCalls - -The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceInternalCalls - -The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveExternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveInternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: New-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# New-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Creates a new TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +``` +New-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-AreaCode ] [-Description ] + [-Enabled ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] + [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## EXAMPLES + +## PARAMETERS + +### -AreaCode + +GUID provided by the CVI partner that the customer signed the agreement with. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + +The policy can exist for the tenant but it can be enabled or disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceExternalCalls + +The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceInternalCalls + +The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveExternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveInternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSharedCallingRoutingPolicy.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsSharedCallingRoutingPolicy.md index 1b61b77f9d..5f268b8fa6 100644 --- a/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy applicable: Microsoft Teams author: serdarsoysal +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: -title: New-CsTeamsSharedCallingRoutingPolicy +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy schema: 2.0.0 +title: New-CsTeamsSharedCallingRoutingPolicy --- # New-CsTeamsSharedCallingRoutingPolicy @@ -49,17 +48,20 @@ The command shown in Example 1 gets the identity and phone number assigned to th ## PARAMETERS -### -Identity -Unique identifier of the Teams shared calling routing policy to be created. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -102,69 +104,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceAccount -The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. +### -Force -The phone number assigned to the resource account must: -- Have the same phone number type and country as the emergency numbers configured in this policy instance. -- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. -- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. +> Applicable: Microsoft Teams -The same resource account can be used in multiple shared calling policy instances. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity +Unique identifier of the Teams shared calling routing policy to be created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -ResourceAccount +The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. + +The phone number assigned to the resource account must: +- Have the same phone number type and country as the emergency numbers configured in this policy instance. +- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. +- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. + +The same resource account can be used in multiple shared calling policy instances. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnection.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnection.md index f09cf35e77..cee35478ec 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: valk online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection schema: 2.0.0 +title: New-CsTeamsShiftsConnection --- # New-CsTeamsShiftsConnection @@ -128,6 +129,21 @@ TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 ## PARAMETERS +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Body The request body. @@ -159,23 +175,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId -The WFM connector ID. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: NewExpanded -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connection name. +### -ConnectorId +The WFM connector ID. ```yaml Type: String @@ -204,13 +220,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline ```yaml -Type: SwitchParameter +Type: SendAsyncStep[] Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -219,8 +235,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline ```yaml Type: SendAsyncStep[] @@ -234,15 +250,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -Name +The connection name. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -324,21 +340,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionBatchTeamMap.md similarity index 97% rename from teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionBatchTeamMap.md index 0dcfcf6db0..54b6cbe110 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionBatchTeamMap.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnectionBatchTeamMap -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap schema: 2.0.0 +title: New-CsTeamsShiftsConnectionBatchTeamMap --- # New-CsTeamsShiftsConnectionBatchTeamMap @@ -55,13 +56,14 @@ Sends 2 team mappings: one maps the Teams team with ID `eddc3b94-21d5-4ef0-a76a- ### -ConnectorInstanceId +> Applicable: Microsoft Teams + The connection instance ID used to map teams. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -71,13 +73,14 @@ Accept wildcard characters: False ### -TeamMapping +> Applicable: Microsoft Teams + The Teams mapping object list. ```yaml Type: TeamMap[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionInstance.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionInstance.md index 9570c08ad4..06b516e112 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: leonardospina external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnectionInstance -author: leonardospina ms.author: lespina -manager: valk online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance schema: 2.0.0 +title: New-CsTeamsShiftsConnectionInstance --- # New-CsTeamsShiftsConnectionInstance @@ -140,29 +141,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorAdminEmail -Gets or sets the list of connector admin email addresses. +### -ConnectionId +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). ```yaml -Type: String[] +Type: String Parameter Sets: NewExpanded Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId -Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -ConnectorAdminEmail +Gets or sets the list of connector admin email addresses. ```yaml -Type: String +Type: String[] Parameter Sets: NewExpanded Aliases: -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False @@ -183,36 +184,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Name +The connector instance name. ```yaml Type: String @@ -225,50 +226,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". - +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: Uri +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioSwapRequest -The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: NewExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String @@ -281,11 +281,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -SyncFrequencyInMin +The sync frequency in minutes. ```yaml -Type: String +Type: Int32 Parameter Sets: NewExpanded Aliases: Required: True @@ -295,8 +295,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -309,36 +309,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connector instance name. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -351,49 +351,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -SyncScenarioSwapRequest +The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + ```yaml -Type: Uri -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: PSCredential -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -406,11 +407,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin -The sync frequency in minutes. +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Int32 +Type: String Parameter Sets: NewExpanded Aliases: Required: True diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsPolicy.md similarity index 94% rename from teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsPolicy.md index 57a7c3e428..800ab59035 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsShiftsPolicy.md @@ -1,228 +1,243 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-teamsshiftspolicy -title: New-CsTeamsShiftsPolicy -schema: 2.0.0 ---- - -# New-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. - -## SYNTAX - -```powershell -New-CsTeamsShiftsPolicy [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] - [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] - [-EnableScheduleOwnerPermissions ] [-Identity] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, schedule owner permissions, and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -``` - -Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the default values to its settings. - -### Example 2 -```powershell -PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false -``` - -Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. - -## PARAMETERS - -### -Identity -Policy instance name. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessType -Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. -Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. -For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: UnrestrictedAccess_TeamsApp -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeFrequency -Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageType -The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. -'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. -'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. -'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. -'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. -'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. -'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. -'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. -'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. -'CustomMessage' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: DefaultMessage -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageCustom -Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessGracePeriodMinutes -Indicates the grace period time in minutes between when the first shift starts or last shift ends and when access is blocked. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableScheduleOwnerPermissions -Indicates whether a user can manage a Shifts schedule as a team member. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-teamsshiftspolicy +schema: 2.0.0 +title: New-CsTeamsShiftsPolicy +--- + +# New-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's properties. + +## SYNTAX + +```powershell +New-CsTeamsShiftsPolicy [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] + [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] + [-EnableScheduleOwnerPermissions ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, schedule owner permissions, and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always +``` + +Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the default values to its settings. + +### Example 2 +```powershell +PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false +``` + +Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. + +## PARAMETERS + +### -AccessGracePeriodMinutes + +> Applicable: Microsoft Teams + +Indicates the grace period time in minutes between when the first shift starts or last shift ends and when access is blocked. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessType + +> Applicable: Microsoft Teams + +Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. +Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. +For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: UnrestrictedAccess_TeamsApp +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableScheduleOwnerPermissions + +> Applicable: Microsoft Teams + +Indicates whether a user can manage a Shifts schedule as a team member. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Microsoft Teams + +Policy instance name. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeFrequency + +> Applicable: Microsoft Teams + +Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageCustom + +> Applicable: Microsoft Teams + +Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageType + +> Applicable: Microsoft Teams + +The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. +'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. +'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. +'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. +'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. +'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. +'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. +'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. +'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. +'CustomMessage' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: DefaultMessage +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliance.md similarity index 94% rename from teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliance.md index e4ca073509..b4636ce042 100644 --- a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliance.md @@ -1,160 +1,165 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliance -title: New-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# New-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -### Identity (Default) - -```powershell -New-CsTeamsSurvivableBranchAppliance [-Identity] [-Description ] [-Site ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey - -```powershell -New-CsTeamsSurvivableBranchAppliance [-Description ] [-Site ] - [-MsftInternalProcessingMode ] -Fqdn [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Free format text. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fqdn - -The FQDN of the SBA. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the SBA. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -The TenantNetworkSite where the SBA is located - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliance +schema: 2.0.0 +title: New-CsTeamsSurvivableBranchAppliance +--- + +# New-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Creates a new Survivable Branch Appliance (SBA) object in the tenant. + +## SYNTAX + +### Identity (Default) + +``` +New-CsTeamsSurvivableBranchAppliance [-Identity] [-Description ] [-Site ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey + +``` +New-CsTeamsSurvivableBranchAppliance [-Description ] [-Site ] + [-MsftInternalProcessingMode ] -Fqdn [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Free format text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn + +The FQDN of the SBA. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the SBA. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site + +The TenantNetworkSite where the SBA is located + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliancePolicy.md index 4fe55cb48c..88861ac273 100644 --- a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,119 +1,124 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliancepolicy -title: New-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# New-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -New-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-BranchApplianceFqdns ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -BranchApplianceFqdns - -The FQDN of the SBA(s) in the site. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The unique identifier. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: New-CsTeamsSurvivableBranchAppliancePolicy +--- + +# New-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Creates a new Survivable Branch Appliance (SBA) policy object in the tenant. + +## SYNTAX + +```powershell +New-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-BranchApplianceFqdns ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -BranchApplianceFqdns + +The FQDN of the SBA(s) in the site. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The unique identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTemplatePermissionPolicy.md similarity index 95% rename from teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsTemplatePermissionPolicy.md index 88462d4a72..0f44b5f551 100644 --- a/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTemplatePermissionPolicy.md @@ -1,163 +1,163 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy -title: New-CsTeamsTemplatePermissionPolicy -author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: -manager: weiliu2 -schema: 2.0.0 ---- - -# New-CsTeamsTemplatePermissionPolicy - -## SYNOPSIS -Creates a new instance of the TeamsTemplatePermissionPolicy. - -## SYNTAX - -``` -New-CsTeamsTemplatePermissionPolicy - [-HiddenTemplates ] - [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Creates a new instance of the policy with a name and a list of hidden Teams template IDs. The template IDs passed into the `HiddenTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist). - -## EXAMPLES - -### Example 1 - -Assuming there are two valid templates with IDs `com.microsoft.teams.template.ManageAProject` and `com.microsoft.teams.template.ManageAnEvent`, we will first create the `HiddenTemplate` objects. - -The next step would be to create the policy instance. -```powershell -PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent -PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject -PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) -PS >New-CsTeamsTemplatePermissionPolicy -Identity Foobar -HiddenTemplates $HiddenList -``` - -```output -Identity HiddenTemplates Description --------- --------------- ----------- -Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} -``` - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of the new policy instance to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. - -You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenTemplates -The list of Teams template IDs to hide. -The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). - -```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Name of the new policy instance to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### TeamsTemplatePermissionPolicy.Cmdlets.TeamsTemplatePermissionPolicy - -## NOTES - -## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) - -[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) - -[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) +--- +author: yishuaihuang4 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy +schema: 2.0.0 +title: New-CsTeamsTemplatePermissionPolicy +--- + +# New-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Creates a new instance of the TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +New-CsTeamsTemplatePermissionPolicy + [-HiddenTemplates ] + [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a new instance of the policy with a name and a list of hidden Teams template IDs. The template IDs passed into the `HiddenTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist). + +## EXAMPLES + +### Example 1 + +Assuming there are two valid templates with IDs `com.microsoft.teams.template.ManageAProject` and `com.microsoft.teams.template.ManageAnEvent`, we will first create the `HiddenTemplate` objects. + +The next step would be to create the policy instance. +```powershell +PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) +PS >New-CsTeamsTemplatePermissionPolicy -Identity Foobar -HiddenTemplates $HiddenList +``` + +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenTemplates +The list of Teams template IDs to hide. +The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsTemplatePermissionPolicy.Cmdlets.TeamsTemplatePermissionPolicy + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTranslationRule.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsTranslationRule.md index e760bec361..f059dfffd6 100644 --- a/teams/teams-ps/teams/New-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule applicable: Microsoft Teams -title: New-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule +schema: 2.0.0 +title: New-CsTeamsTranslationRule --- # New-CsTeamsTranslationRule @@ -76,15 +77,16 @@ This example creates a rule that adds the last four digits of a phone number sta ## PARAMETERS -### -Identity -The Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: (Identity) -Aliases: -Required: True -Position: 1 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -105,58 +107,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Pattern -A regular expression that caller or callee number must match in order for this rule to be applied. +### -Identity +The Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (Identity) Aliases: - -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Translation -The regular expression pattern that will be applied to the number to convert it. +### -Name +The name of the rule. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: (ParentAndRelativeKey) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The name of the rule. +### -Pattern +A regular expression that caller or callee number must match in order for this rule to be applied. ```yaml Type: String -Parameter Sets: (ParentAndRelativeKey) +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. +### -Translation +The regular expression pattern that will be applied to the number to convert it. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -165,13 +166,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUnassignedNumberTreatment.md similarity index 96% rename from teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsUnassignedNumberTreatment.md index cf47048628..476f269f29 100644 --- a/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUnassignedNumberTreatment.md @@ -1,201 +1,200 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment -applicable: Microsoft Teams -title: New-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# New-CsTeamsUnassignedNumberTreatment - -## SYNOPSIS -Creates a new treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. - -## SYNTAX - -### Identity (Default) -``` -New-CsTeamsUnassignedNumberTreatment [-Identity] [-Description ] [-Pattern ] [-Target ] - [-TargetType ] [-TreatmentPriority ] - [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey -``` -New-CsTeamsUnassignedNumberTreatment -TreatmentId [-Description ] [-Pattern ] [-Target ] - [-TargetType ] [-TreatmentPriority ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet creates a treatment for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa@contoso.com).ObjectId -New-CsTeamsUnassignedNumberTreatment -Identity MainAA -Pattern "^\+15552223333$" -TargetType ResourceAccount -Target $RAObjectId -TreatmentPriority 1 -``` -This example creates a treatment that will route all calls to the number +1 (555) 222-3333 to the resource account aa@contoso.com. -That resource account is associated with an Auto Attendant (not part of the example). - -### Example 2 -```powershell -$Content = Get-Content "C:\Media\MainAnnoucement.wav" -Encoding byte -ReadCount 0 -$AudioFile = Import-CsOnlineAudioFile -FileName "MainAnnouncement.wav" -Content $Content -$Fid=[System.Guid]::Parse($audioFile.Id) -New-CsTeamsUnassignedNumberTreatment -Identity TR1 -Pattern "^\+1555333\d{4}$" -TargetType Announcement -Target $Fid.Guid -TreatmentPriority 2 -``` -This example creates a treatment that will route all calls to unassigned numbers in the range +1 (555) 333-0000 to +1 (555) 333-9999 to the announcement service, -where the audio file MainAnnouncement.wav will be played to the caller. - -### Example 3 -```powershell -$UserObjectId = (Get-CsOnlineUser -Identity user@contoso.com).Identity -New-CsTeamsUnassignedNumberTreatment -Identity TR2 -Pattern "^\+15552224444$" -TargetType User -Target $UserObjectId -TreatmentPriority 3 -``` -This example creates a treatment that will route all calls to the number +1 (555) 222-4444 to the user user@contoso.com. - -## PARAMETERS - -### -Description -Free format description of this treatment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Id of the treatment. - -```yaml -Type: System.String -Parameter Sets: (Identity) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern -A regular expression that the called number must match in order for the treatment to take effect. It is best practice to start the regular expression with the hat character and end it with the dollar character. -You can use various regular expression test sites on the Internet to validate the expression. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetType -The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatmentId -The identity of the treatment. - -```yaml -Type: System.String -Parameter Sets: (ParentAndRelativeKey) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatmentPriority -The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - -```yaml -Type: System.Integer -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.5.1 or later. - -The parameters Identity and TreatmentId are mutually exclusive. - -To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. - -To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. - -Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. - -If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to -the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains -a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. - -## RELATED LINKS -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) - -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) - -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) - -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) - -[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment +schema: 2.0.0 +title: New-CsTeamsUnassignedNumberTreatment +--- + +# New-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +Creates a new treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsUnassignedNumberTreatment [-Identity] [-Description ] [-Pattern ] [-Target ] + [-TargetType ] [-TreatmentPriority ] + [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsTeamsUnassignedNumberTreatment -TreatmentId [-Description ] [-Pattern ] [-Target ] + [-TargetType ] [-TreatmentPriority ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet creates a treatment for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa@contoso.com).ObjectId +New-CsTeamsUnassignedNumberTreatment -Identity MainAA -Pattern "^\+15552223333$" -TargetType ResourceAccount -Target $RAObjectId -TreatmentPriority 1 +``` +This example creates a treatment that will route all calls to the number +1 (555) 222-3333 to the resource account aa@contoso.com. +That resource account is associated with an Auto Attendant (not part of the example). + +### Example 2 +```powershell +$Content = Get-Content "C:\Media\MainAnnoucement.wav" -Encoding byte -ReadCount 0 +$AudioFile = Import-CsOnlineAudioFile -FileName "MainAnnouncement.wav" -Content $Content +$Fid=[System.Guid]::Parse($audioFile.Id) +New-CsTeamsUnassignedNumberTreatment -Identity TR1 -Pattern "^\+1555333\d{4}$" -TargetType Announcement -Target $Fid.Guid -TreatmentPriority 2 +``` +This example creates a treatment that will route all calls to unassigned numbers in the range +1 (555) 333-0000 to +1 (555) 333-9999 to the announcement service, +where the audio file MainAnnouncement.wav will be played to the caller. + +### Example 3 +```powershell +$UserObjectId = (Get-CsOnlineUser -Identity user@contoso.com).Identity +New-CsTeamsUnassignedNumberTreatment -Identity TR2 -Pattern "^\+15552224444$" -TargetType User -Target $UserObjectId -TreatmentPriority 3 +``` +This example creates a treatment that will route all calls to the number +1 (555) 222-4444 to the user user@contoso.com. + +## PARAMETERS + +### -Description +Free format description of this treatment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the treatment. + +```yaml +Type: System.String +Parameter Sets: (Identity) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that the called number must match in order for the treatment to take effect. It is best practice to start the regular expression with the hat character and end it with the dollar character. +You can use various regular expression test sites on the Internet to validate the expression. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetType +The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatmentId +The identity of the treatment. + +```yaml +Type: System.String +Parameter Sets: (ParentAndRelativeKey) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatmentPriority +The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + +```yaml +Type: System.Integer +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +The parameters Identity and TreatmentId are mutually exclusive. + +To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. + +To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. + +Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. + +If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to +the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains +a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. + +## RELATED LINKS +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) + +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) + +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) + +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUpdateManagementPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsUpdateManagementPolicy.md index 940828e939..ad8ad01393 100644 --- a/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- +applicable: Microsoft Teams +author: vargasj-ms external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: gnamun Module Name: MicrosoftTeams +ms.author: vargasj online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsupdatemanagementpolicy -applicable: Microsoft Teams -title: New-CsTeamsUpdateManagementPolicy schema: 2.0.0 -author: vargasj-ms -ms.author: vargasj -manager: gnamun +title: New-CsTeamsUpdateManagementPolicy --- # New-CsTeamsUpdateManagementPolicy @@ -44,41 +45,6 @@ Disable the in-product messages with the category "What's New". ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledInProductMessages -List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: - -| ID | Campaign Category | -| -- | -- | -| 91382d07-8b89-444c-bbcb-cfe43133af33| What's New | -| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | - -```yaml -Type: System.Management.Automation.PSListModifier`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowManagedUpdates Enables/Disables managed updates for the user. @@ -168,6 +134,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. @@ -184,12 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateDayOfWeek +### -DisabledInProductMessages +List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: - Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. +| ID | Campaign Category | +| -- | -- | +| 91382d07-8b89-444c-bbcb-cfe43133af33| What's New | +| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | ```yaml -Type: Int64 +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) Aliases: @@ -200,12 +185,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTime - -Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. +### -Force +Suppress all non-fatal errors. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -216,12 +200,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTimeOfDay +### -Identity +A unique identifier. -Machine local time. Can be set only when AllowManagedUpdates is set to True +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OCDIRedirect + +This setting controls whether users are redirected from teams.microsoft.com to the unified domain teams.cloud.microsoft. Possible values are: +- **Microsoft Default**, Microsoft will manage redirection behavior. If no explicit admin configuration is set, users may be redirected automatically. +- **Disabled**, Users will remain on teams.microsoft.com. Use this if your organization's apps are incompatible with the unified domain. +- **Enabled**, Users will be redirected to teams.cloud.microsoft. Use this only if your organization had previously opted out of redirection and now wants to opt back in. ```yaml -Type: DateTime +Type: String Parameter Sets: (All) Aliases: @@ -232,17 +234,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNewTeamsClient +### -UpdateDayOfWeek -This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. - If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. - If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. - If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. - If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. - If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. + Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. ```yaml -Type: String +Type: Int64 Parameter Sets: (All) Aliases: @@ -253,12 +250,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OCDIRedirect +### -UpdateTime -This setting controls whether users are redirected from teams.microsoft.com to the unified domain teams.cloud.microsoft. Possible values are: -- **Microsoft Default**, Microsoft will manage redirection behavior. If no explicit admin configuration is set, users may be redirected automatically. -- **Disabled**, Users will remain on teams.microsoft.com. Use this if your organization's apps are incompatible with the unified domain. -- **Enabled**, Users will be redirected to teams.cloud.microsoft. Use this only if your organization had previously opted out of redirection and now wants to opt back in. +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. ```yaml Type: String @@ -272,11 +266,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppress all non-fatal errors. +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) Aliases: @@ -287,16 +282,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -A unique identifier. +### -UseNewTeamsClient + +This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. + If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. + If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. + If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. + If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. + If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVdiPolicy.md similarity index 89% rename from teams/teams-ps/teams/New-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsVdiPolicy.md index a8a03debbe..50ad05f548 100644 --- a/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVdiPolicy.md @@ -1,165 +1,164 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvdipolicy -title: New-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# New-CsTeamsVdiPolicy - -## SYNOPSIS -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -```powershell -New-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] - [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -The New-CsTeamsVdiPolicy cmdlet allows administrators to define new Vdi policies that can be assigned to particular users to control Teams features related to meetings on a VDI environment. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" -``` - -The command shown in Example 1 uses the New-CsTeamsVdiPolicy cmdlet to create a new Vdi policy with the Identity RestrictedUserPolicy. This policy will use all the default values for a vdi policy except one: VDI2Optimization; in this example, users with this policy will not be able to be VDI 2.0 optimized. - -### Example 2 -```powershell -PS C:\> New-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True -``` - -In Example 2, the New-CsTeamsVdiPolicy cmdlet is used to create a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the default values. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAudioVideoInCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VDI2Optimization -Determines whether a user can be VDI 2.0 optimized. -* Enabled - allow a user to be VDI 2.0 optimized. -* Disabled - disallow a user to be VDI 2.0 optimized. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvdipolicy +schema: 2.0.0 +title: New-CsTeamsVdiPolicy +--- + +# New-CsTeamsVdiPolicy + +## SYNOPSIS +The New-CsTeamsVdiPolicy cmdlet allows administrators to define new Vdi policies that can be assigned to particular users to control Teams features related to meetings on a VDI environment. + +## SYNTAX + +```powershell +New-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] + [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting for an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" +``` + +The command shown in Example 1 uses the New-CsTeamsVdiPolicy cmdlet to create a new Vdi policy with the Identity RestrictedUserPolicy. This policy will use all the default values for a vdi policy except one: VDI2Optimization; in this example, users with this policy will not be able to be VDI 2.0 optimized. + +### Example 2 +```powershell +PS C:\> New-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True +``` + +In Example 2, the New-CsTeamsVdiPolicy cmdlet is used to create a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the default values. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAudioVideoInCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VDI2Optimization +Determines whether a user can be VDI 2.0 optimized. +* Enabled - allow a user to be VDI 2.0 optimized. +* Disabled - disallow a user to be VDI 2.0 optimized. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVirtualAppointmentsPolicy.md similarity index 98% rename from teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsVirtualAppointmentsPolicy.md index e231df2c8c..ea5b05d6e5 100644 --- a/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams +ms.author: erocha online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy -title: New-CsTeamsVirtualAppointmentsPolicy schema: 2.0.0 -ms.author: erocha -author: emmanuelrocha001 -manager: sonaggarwal +title: New-CsTeamsVirtualAppointmentsPolicy --- # New-CsTeamsVirtualAppointmentsPolicy @@ -66,13 +67,15 @@ Accept wildcard characters: False ``` ### -EnableSmsNotifications + +> Applicable: Microsoft Teams + This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment template meeting. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVoiceApplicationsPolicy.md similarity index 99% rename from teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsVoiceApplicationsPolicy.md index fd60490292..5db8c85859 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsVoiceApplicationsPolicy.md @@ -1,10 +1,11 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy -title: New-CsTeamsVoiceApplicationsPolicy -schema: 2.0.0 ROBOTS: NOINDEX +schema: 2.0.0 +title: New-CsTeamsVoiceApplicationsPolicy --- # New-CsTeamsVoiceApplicationsPolicy @@ -85,25 +86,25 @@ The command shown in Example 2 creates a new per-user Teams voice applications p ## PARAMETERS -### -Identity +### -AllowAutoAttendantAfterHoursGreetingChange -Unique identifier assigned to the policy when it was created. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True -Position: 2 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursGreetingChange +### -AllowAutoAttendantAfterHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. ```yaml Type: Boolean @@ -117,9 +118,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursGreetingChange +### -AllowAutoAttendantBusinessHoursChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. ```yaml Type: Boolean @@ -133,9 +134,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayGreetingChange +### -AllowAutoAttendantBusinessHoursGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -149,9 +150,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursChange +### -AllowAutoAttendantBusinessHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. ```yaml Type: Boolean @@ -165,9 +166,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidaysChange +### -AllowAutoAttendantHolidayGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. ```yaml Type: Boolean @@ -181,11 +182,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantTimeZoneChange - -_This feature is not currently available to authorized users._ +### -AllowAutoAttendantHolidayRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. ```yaml Type: Boolean @@ -199,11 +198,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantLanguageChange - -_This feature is not currently available to authorized users._ +### -AllowAutoAttendantHolidaysChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. ```yaml Type: Boolean @@ -217,9 +214,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursRoutingChange +### -AllowAutoAttendantLanguageChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. ```yaml Type: Boolean @@ -233,9 +232,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursRoutingChange +### -AllowAutoAttendantTimeZoneChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. ```yaml Type: Boolean @@ -249,9 +250,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayRoutingChange +### -AllowCallQueueAgentOptChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. ```yaml Type: Boolean @@ -265,9 +266,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange +### -AllowCallQueueConferenceModeChange -When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. ```yaml Type: Boolean @@ -281,9 +282,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMusicOnHoldChange +### -AllowCallQueueLanguageChange -When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. ```yaml Type: Boolean @@ -297,9 +300,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowSharedVoicemailGreetingChange +### -AllowCallQueueMembershipChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. ```yaml Type: Boolean @@ -313,9 +316,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutSharedVoicemailGreetingChange +### -AllowCallQueueMusicOnHoldChange -When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -347,11 +350,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange - -_This feature is not currently available to authorized users._ +### -AllowCallQueueNoAgentsRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -365,9 +366,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMembershipChange +### -AllowCallQueueOptOutChange -When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. ```yaml Type: Boolean @@ -381,9 +382,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +### -AllowCallQueueOverflowRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. ```yaml Type: Boolean @@ -397,9 +398,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueRoutingMethodChange +### -AllowCallQueueOverflowSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -429,25 +430,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOptOutChange - -When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallQueueOverflowRoutingChange +### -AllowCallQueueRoutingMethodChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. ```yaml Type: Boolean @@ -477,9 +462,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentsRoutingChange +### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -493,9 +478,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueAgentOptChange +### -AllowCallQueueWelcomeGreetingChange -When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -557,22 +542,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAutoAttendantMetricsPermission - -PARAMVALUE: Disabled | AuthorizedOnly | All - -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. - -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. +### -Confirm -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` won't be able to access real-time metrics. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Object -Parameter Sets: Dual -Aliases: -applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -581,22 +558,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeCallQueueMetricsPermission - -PARAMVALUE: Disabled | AuthorizedOnly | All - -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. - -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. +### -Description -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` won't be able to access real-time metrics. +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. ```yaml -Type: Object -Parameter Sets: Dual +Type: String +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -605,16 +574,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAgentMetricsPermission +### -HistoricalAgentMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` won't be able to access real-time metrics. +When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. ```yaml Type: Object @@ -675,15 +643,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalAgentMetricsPermission +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAgentMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. -When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. -When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml Type: Object @@ -698,15 +683,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -RealTimeAutoAttendantMetricsPermission -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -715,14 +707,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -RealTimeCallQueueMetricsPermission -Prompts you for confirmation before running the cmdlet. +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -731,14 +731,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -WhatIf -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLoadPolicy.md similarity index 94% rename from teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLoadPolicy.md index e2f6188c48..17f4d3b0c9 100644 --- a/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLoadPolicy.md @@ -1,239 +1,240 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy -title: New-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# New-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet creates a Teams Workload Policy instance for the tenant. - -## SYNTAX - -```powershell -New-CsTeamsWorkLoadPolicy [-Identity] [-AllowCalling ] [-AllowCallingPinned ] - [-AllowMeeting ] [-AllowMeetingPinned ] [-AllowMessaging ] - [-AllowMessagingPinned ] [-Description ] [-MsftInternalProcessingMode ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-CsTeamsWorkLoadPolicy -Identity Test -``` - -Creates a new Teams Workload Policy with the specified identity of "Test". - -## PARAMETERS - -### -AllowCalling - -Determines if calling workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallingPinned - -Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeeting - -Determines if meetings workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetingPinned - -Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessaging - -Determines if messaging workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessagingPinned - -Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide explanatory text about the Teams Workload policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the Teams Workload Policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Microsoft Internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy +schema: 2.0.0 +title: New-CsTeamsWorkLoadPolicy +--- + +# New-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet creates a Teams Workload Policy instance for the tenant. + +## SYNTAX + +```powershell +New-CsTeamsWorkLoadPolicy [-Identity] [-AllowCalling ] [-AllowCallingPinned ] + [-AllowMeeting ] [-AllowMeetingPinned ] [-AllowMessaging ] + [-AllowMessagingPinned ] [-Description ] [-MsftInternalProcessingMode ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsTeamsWorkLoadPolicy -Identity Test +``` + +Creates a new Teams Workload Policy with the specified identity of "Test". + +## PARAMETERS + +### -AllowCalling + +Determines if calling workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallingPinned + +Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeeting + +Determines if meetings workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingPinned + +Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessaging + +Determines if messaging workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessagingPinned + +Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the Teams Workload policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLocationDetectionPolicy.md similarity index 87% rename from teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLocationDetectionPolicy.md index c99f3955de..3623bfe44e 100644 --- a/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTeamsWorkLocationDetectionPolicy.md @@ -1,18 +1,19 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur Module Name: MicrosoftTeams +ms.author: arkozlov online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy -title: New-CsTeamsWorkLocationDetectionPolicy schema: 2.0.0 -ms.author: arkozlov -manager: prashibadkur -author: artemiykozlov +title: New-CsTeamsWorkLocationDetectionPolicy --- # New-CsTeamsWorkLocationDetectionPolicy ## SYNOPSIS -This cmdlet is used to create a new instance of the TeamsWorkLocationDetectionPolicy. The end user experience utilizing this policy has rolled out to the general public. You can see updates at [Microsoft 365 Roadmap | Microsoft 365](https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2Cset%2Cwork%2Clocation%22https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2cset%2cwork%2clocation%22) and to learn more on how to enable the end user experience, please see [Setting up Bookable Desks in Microsoft Teams - Microsoft Teams | Microsoft Learn.](https://learn.microsoft.com/microsoftteams/rooms/bookable-desks) +This cmdlet is used to create a new instance of the TeamsWorkLocationDetectionPolicy. ## SYNTAX @@ -25,6 +26,8 @@ New-CsTeamsWorkLocationDetectionPolicy [-EnableWorkLocationDetection ] Creates a new instance of the TeamsWorkLocationDetectionPolicy. This policy can be used to tailor the work location detection experience. The parameter `EnableWorkLocationDetection` allows your organization to collect the work location of users when they connect, interact, or are detected near your organization's networks and devices. It also captures the geographic location information users share from personal and mobile devices. This gives users the ability to consent to the use of this location data to set their current work location.Microsoft collects this information to provide users with a consistent location-based experience and to improve the hybrid work experience in Microsoft 365 according to the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839). +The end user experience utilizing this policy has rolled out to the general public. You can see updates at [Microsoft 365 Roadmap | Microsoft 365](https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2Cset%2Cwork%2Clocation%22https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2cset%2cwork%2clocation%22) and to learn more on how to enable the end user experience, please see [Setting up Bookable Desks in Microsoft Teams - Microsoft Teams | Microsoft Learn.](https://learn.microsoft.com/microsoftteams/rooms/bookable-desks). + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/New-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantDialPlan.md similarity index 95% rename from teams/teams-ps/teams/New-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantDialPlan.md index 3496d58772..bfe9dca2c9 100644 --- a/teams/teams-ps/teams/New-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan applicable: Microsoft Teams -title: New-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan +schema: 2.0.0 +title: New-CsTenantDialPlan --- # New-CsTenantDialPlan @@ -31,14 +32,14 @@ You can add new normalization rules to a tenant dial plan by calling the [New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsTenantDialPlan -Identity vt1tenantDialPlan9 ``` This example creates a tenant dial plan that has an Identity of vt1tenantDialPlan9. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $nr2 = New-CsVoiceNormalizationRule -Identity Global/NR2 -Description "TestNR1" -Pattern '^(d{11})$' -Translation '+1' -InMemory New-CsTenantDialPlan -Identity vt1tenantDialPlan91 -NormalizationRules @{Add=$nr2} @@ -48,33 +49,16 @@ This example creates a new normalization rule and then applies that rule to a ne ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier that designates the name of the tenant dial plan. -Identity is an alphanumeric string that cannot exceed 49 characters. -Valid characters are alphabetic or numeric characters, hyphen (-) and dot (.). -The value should not begin with a (.) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Confirm -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confirm The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -84,6 +68,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to and any other information that helps to identify the purpose of the tenant dial plan. Maximum characters: 1040. @@ -91,7 +78,6 @@ Maximum characters: 1040. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -100,7 +86,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter is a unique identifier that designates the name of the tenant dial plan. +Identity is an alphanumeric string that cannot exceed 49 characters. +Valid characters are alphabetic or numeric characters, hyphen (-) and dot (.). +The value should not begin with a (.) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NormalizationRules + +> Applicable: Microsoft Teams + The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet, which creates the rule and then assign it to the specified tenant dial plan using [Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) cmdlet. @@ -114,7 +124,6 @@ You can create a new normalization rule by calling the [New-CsVoiceNormalization Type: List Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -124,6 +133,9 @@ Accept wildcard characters: False ``` ### -SimpleName + +> Applicable: Microsoft Teams + The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. @@ -137,7 +149,6 @@ However, if you don't provide a value, a default value matching the Identity of Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -147,6 +158,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -154,7 +168,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/New-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkRegion.md similarity index 90% rename from teams/teams-ps/teams/New-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkRegion.md index 33bb7d2c2d..7f4ba683c0 100644 --- a/teams/teams-ps/teams/New-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkRegion.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion applicable: Microsoft Teams -title: New-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion +schema: 2.0.0 +title: New-CsTenantNetworkRegion --- # New-CsTenantNetworkRegion ## SYNOPSIS -As an admin, you can use the Teams PowerShell command, New-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. +Creates a new network region. ## SYNTAX @@ -30,6 +31,8 @@ New-CsTenantNetworkRegion -NetworkRegionID [-BypassID ] [-Centr ``` ## DESCRIPTION +A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. + Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. ## EXAMPLES @@ -43,22 +46,22 @@ The command shown in Example 1 creates the network region 'RegionA' with no desc ## PARAMETERS -### -Identity -Unique identifier for the network region to be created. +### -BypassID +This parameter is not used. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassID +### -CentralSite This parameter is not used. ```yaml @@ -73,13 +76,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CentralSite -This parameter is not used. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -103,30 +106,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -The name of the network region. This must be a string that is unique. You cannot specify an NetworkRegionID and an Identity at the same time. +### -Identity +Unique identifier for the network region to be created. ```yaml Type: String -Parameter Sets: ParentAndRelativeKey +Parameter Sets: Identity Aliases: Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkRegionID +The name of the network region. This must be a string that is unique. You cannot specify an NetworkRegionID and an Identity at the same time. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/New-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSite.md similarity index 99% rename from teams/teams-ps/teams/New-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSite.md index 81412644a9..9af7cb1d13 100644 --- a/teams/teams-ps/teams/New-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite applicable: Microsoft Teams -title: New-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite +schema: 2.0.0 +title: New-CsTenantNetworkSite --- # New-CsTenantNetworkSite @@ -66,16 +67,16 @@ PS C:\> New-CsTenantNetworkSite -NetworkSiteID "site3" -Description "site 3" -Ne The command shown in Example 3 creates the network site 'site3' with the description 'site 3'. This site is enabled for network roaming capabilities. The example associates the site with network region 'RedmondRegion' and network roaming policy 'TestNetworkRoamingPolicy'. ## PARAMETERS -### -Identity -Unique identifier for the network site to be created. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -96,8 +97,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmergencyCallRoutingPolicy -This parameter is used to assign a custom emergency call routing policy to a network site. For more information, see [Assign a custom emergency call routing policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). +### -EmergencyCallingPolicy +This parameter is used to assign a custom emergency calling policy to a network site. For more information see [Assign a custom emergency calling policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). ```yaml Type: String @@ -111,8 +112,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmergencyCallingPolicy -This parameter is used to assign a custom emergency calling policy to a network site. For more information see [Assign a custom emergency calling policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). +### -EmergencyCallRoutingPolicy +This parameter is used to assign a custom emergency call routing policy to a network site. For more information, see [Assign a custom emergency call routing policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). ```yaml Type: String @@ -141,6 +142,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique identifier for the network site to be created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocationPolicy This parameter is reserved for Microsoft internal use. @@ -216,21 +232,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSubnet.md similarity index 84% rename from teams/teams-ps/teams/New-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSubnet.md index 0639975119..e0a990226f 100644 --- a/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsTenantNetworkSubnet.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet applicable: Microsoft Teams -title: New-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet +schema: 2.0.0 +title: New-CsTenantNetworkSubnet --- # New-CsTenantNetworkSubnet ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, New-CsTenantNetworkSubnet to define network subnets and assign them to network sites. Each internal subnet may only be associated with one site. Tenant network subnet is used for Location Based Routing. +Creates a new network subnet. ## SYNTAX @@ -30,7 +31,7 @@ New-CsTenantNetworkSubnet -MaskBits -SubnetID [-Description ] -IPAddress [-MaskB ## DESCRIPTION External trusted IPs are the Internet external IPs of the enterprise network and are used to determine if the user's endpoint is inside the corporate network before checking for a specific site match. If the user's external IP matches one defined in the trusted list, then Location-Based Routing will check to determine which internal subnet the user's endpoint is located. If the user's external IP doesn't match one defined in the trusted list, the endpoint will be classified as being at an unknown and any PSTN calls to/from an LBR enabled user are blocked. -Both IPv4 and IPv6 trusted IP addresses are supported. +Both IPv4 and IPv6 trusted IP addresses are supported. You can define an unlimited number of external subnets for a tenant. ## EXAMPLES @@ -108,21 +108,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IPAddress -The name of the IP address. This must be a unique and valid IPv4 or IPv6 address. You cannot specify an IP address and an Identity at the same time. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier for the IP address to be created. @@ -153,6 +138,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IPAddress +The name of the IP address. This must be a unique and valid IPv4 or IPv6 address. You cannot specify an IP address and an Identity at the same time. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MaskBits This parameter determines the length of bits to mask to the subnet. diff --git a/teams/teams-ps/teams/New-CsUserCallingDelegate.md b/teams/teams-ps/MicrosoftTeams/New-CsUserCallingDelegate.md similarity index 95% rename from teams/teams-ps/teams/New-CsUserCallingDelegate.md rename to teams/teams-ps/MicrosoftTeams/New-CsUserCallingDelegate.md index bcb61efbcc..3c9b388022 100644 --- a/teams/teams-ps/teams/New-CsUserCallingDelegate.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsUserCallingDelegate.md @@ -1,137 +1,136 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate -applicable: Microsoft Teams -title: New-CsUserCallingDelegate -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# New-CsUserCallingDelegate - -## SYNOPSIS -This cmdlet will add a new delegate for calling in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -```powershell -New-CsUserCallingDelegate -Identity -Delegate -MakeCalls -ReceiveCalls -ManageSettings [] -``` - -## DESCRIPTION -This cmdlet adds a new delegate with given permissions for the specified user. - -## EXAMPLES - -### Example 1 -```powershell -New-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -ReceiveCalls $true -ManageSettings $true -``` - -## PARAMETERS - -### -Delegate -The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. - -A user can have up to 25 delegates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeCalls - -Specifies whether delegate is allowed to make calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: True -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManageSettings - -Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: True -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveCalls - -Specifies whether delegate is allowed to receive calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: True -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, -and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -The specified user need to have the Microsoft Phone System license assigned. - -You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. - -## RELATED LINKS -[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate +schema: 2.0.0 +title: New-CsUserCallingDelegate +--- + +# New-CsUserCallingDelegate + +## SYNOPSIS +This cmdlet will add a new delegate for calling in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +```powershell +New-CsUserCallingDelegate -Identity -Delegate -MakeCalls -ReceiveCalls -ManageSettings [] +``` + +## DESCRIPTION +This cmdlet adds a new delegate with given permissions for the specified user. + +## EXAMPLES + +### Example 1 +```powershell +New-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -ReceiveCalls $true -ManageSettings $true +``` + +## PARAMETERS + +### -Delegate +The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. + +A user can have up to 25 delegates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeCalls + +Specifies whether delegate is allowed to make calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: True +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageSettings + +Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: True +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveCalls + +Specifies whether delegate is allowed to receive calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: True +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, +and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +The specified user need to have the Microsoft Phone System license assigned. + +You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. + +## RELATED LINKS +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/New-CsVideoInteropServiceProvider.md similarity index 96% rename from teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/New-CsVideoInteropServiceProvider.md index 06ece90114..bc2eac6a8f 100644 --- a/teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsVideoInteropServiceProvider.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csvideointeropserviceprovider applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: New-CsVideoInteropServiceProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/new-csvideointeropserviceprovider +schema: 2.0.0 +title: New-CsVideoInteropServiceProvider --- # New-CsVideoInteropServiceProvider ## SYNOPSIS -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. +Use the New-CsVideoInteropServiceProvider to specify information about a supported CVI partner your organization would like to use. ## SYNTAX @@ -35,8 +36,6 @@ New-CsVideoInteropServiceProvider [-Tenant ] -Name [-AadAp ## DESCRIPTION Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. -Use the New-CsVideoInteropServiceProvider to specify information about a supported CVI partner your organization would like to use. - Important note: New-CsVideoInteropServiceProvider does not do a check on the -Identity to be one of the Identity (without tag:) from the Get-CsTeamsVideoInteropServicePolicy, however if this is not set to match, the VTC coordinates will not added to the meetings correctly. Make sure that your "Identity" matches a valid policy identity. ## EXAMPLES diff --git a/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md b/teams/teams-ps/MicrosoftTeams/New-CsVoiceNormalizationRule.md similarity index 87% rename from teams/teams-ps/teams/New-CsVoiceNormalizationRule.md rename to teams/teams-ps/MicrosoftTeams/New-CsVoiceNormalizationRule.md index 50a147a31f..2181c510c9 100644 --- a/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md +++ b/teams/teams-ps/MicrosoftTeams/New-CsVoiceNormalizationRule.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule applicable: Microsoft Teams -title: New-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule +schema: 2.0.0 +title: New-CsVoiceNormalizationRule --- # New-CsVoiceNormalizationRule @@ -14,11 +16,6 @@ ms.author: serdars ## SYNOPSIS Creates a new voice normalization rule. -Voice normalization rules are used to convert a telephone dialing requirement (for example, dialing 9 to access an outside line) to the E.164 phone number format used by -Skype for Business Server or Microsoft Teams. - -This cmdlet was introduced in Lync Server 2010. - ## SYNTAX ### Identity (Default) @@ -36,7 +33,11 @@ New-CsVoiceNormalizationRule [-Tenant ] -Parent -Name [- ``` ## DESCRIPTION -This cmdlet creates a named voice normalization rule. + +This cmdlet was introduced in Lync Server 2010. + +Voice normalization rules are used to convert a telephone dialing requirement (for example, dialing 9 to access an outside line) to the E.164 phone number format used by Skype for Business Server or Microsoft Teams. + These rules are a required part of phone authorization and call routing. They define the requirements for converting (or translating) numbers from an internal format to a standard (E.164) format. An understanding of regular expressions is helpful in order to define number patterns that will be translated. @@ -51,7 +52,7 @@ the `New-CsTenantDialPlan` or `Set-CsTenantDialPlan` cmdlets. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" ``` @@ -64,7 +65,7 @@ If the rule name does not contain a space you don't need to enclose the Identity Keep in mind that a dial plan for the Redmond site must exist for this command to succeed. You can create a new dial plan by calling the `New-CsDialPlan` cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoiceNormalizationRule -Parent SeattleUser -Name SeattleFourDigit -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' ``` @@ -81,7 +82,7 @@ Single quotes are required for these values; double quotes (or no quotes) will n As in Example 1, a dial plan with the given scope must exist. In this case, that means a dial plan with the Identity SeattleUser must already exist. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $nr1=New-CsVoiceNormalizationRule -Identity dp1/nr1 -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' -InMemory New-CsTenantDialPlan -Identity DP1 -NormalizationRules @{Add=$nr1} @@ -91,64 +92,49 @@ This example creates a new in-memory voice normalization rule and then adds it t ## PARAMETERS -### -Identity -A unique identifier for the rule. -The Identity specified must include the scope followed by a slash and then the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. -The name portion will automatically be stored in the Name property. -You cannot specify values for Identity and Name in the same command. - -For Lync and Skype for Business Server, voice normalization rules can be created at the following scopes: global, site, service (Registrar and PSTNGateway only) and per user. -A dial plan with an Identity matching the scope of the normalization rule must already exist before a new rule can be created. -(To retrieve a list of dial plans, call the `Get-CsDialPlan` cmdlet.) +### -Confirm -For Microsoft Teams, voice normalization rules can be created at the following scopes: global and tag. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -The Identity parameter is required unless the Parent parameter is specified. -You cannot include the Identity parameter and the Parent parameter in the same command. +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The name of the rule. -This parameter is required if a value has been specified for the Parent parameter. -If no value has been specified for the Parent parameter, Name defaults to the name specified in the Identity parameter. -For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. -The Name parameter and the Identity parameter cannot be used in the same command. +### -Description +A friendly description of the normalization rule. + +Maximum string length: 512 characters. ```yaml Type: String -Parameter Sets: ParentAndRelativeKey +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -The scope at which the new normalization rule will be created. -This value must be global; site:\, where \ is the name of the Skype for Business Server site; PSTN gateway or Registrar service, such as -PSTNGateway:redmond.litwareinc.com; or a string designating a per user rule. -A dial plan with the specified scope must already exist or the command will fail. +### -Force -The Parent parameter is required unless the Identity parameter is specified. -You cannot include the Identity parameter and the Parent parameter in the same command. -If you include the Parent parameter, the Name parameter is also required. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -159,35 +145,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A friendly description of the normalization rule. +### -Identity +A unique identifier for the rule. +The Identity specified must include the scope followed by a slash and then the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +The name portion will automatically be stored in the Name property. +You cannot specify values for Identity and Name in the same command. -Maximum string length: 512 characters. +For Lync and Skype for Business Server, voice normalization rules can be created at the following scopes: global, site, service (Registrar and PSTNGateway only) and per user. +A dial plan with an Identity matching the scope of the normalization rule must already exist before a new rule can be created. +(To retrieve a list of dial plans, call the `Get-CsDialPlan` cmdlet.) + +For Microsoft Teams, voice normalization rules can be created at the following scopes: global and tag. + +The Identity parameter is required unless the Parent parameter is specified. +You cannot include the Identity parameter and the Parent parameter in the same command. ```yaml -Type: String -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IsInternalExtension -If True, the result of applying this rule will be a number internal to the organization. -If False, applying the rule results in an external number. -This value is ignored if the value of the OptimizeDeviceDialing property of the associated dial plan/tenant dial plan is set to False. +### -InMemory -Default: False +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. + +For Lync or Skype for Business Server, if you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the +object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -196,16 +193,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Pattern -A regular expression that the dialed number must match in order for this rule to be applied. +### -IsInternalExtension -Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +If True, the result of applying this rule will be a number internal to the organization. +If False, applying the rule results in an external number. +This value is ignored if the value of the OptimizeDeviceDialing property of the associated dial plan/tenant dial plan is set to False. + +Default: False ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -214,34 +215,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -The order in which rules are applied. -A phone number might match more than one rule. -This parameter sets the order in which the rules are tested against the number. +### -Name +The name of the rule. +This parameter is required if a value has been specified for the Parent parameter. +If no value has been specified for the Parent parameter, Name defaults to the name specified in the Identity parameter. +For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. +The Name parameter and the Identity parameter cannot be used in the same command. ```yaml -Type: Int32 -Parameter Sets: (All) +Type: String +Parameter Sets: ParentAndRelativeKey Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Translation -The regular expression pattern that will be applied to the number to convert it to E.164 format. +### -Parent +The scope at which the new normalization rule will be created. +This value must be global; site:\, where \ is the name of the Skype for Business Server site; PSTN gateway or Registrar service, such as +PSTNGateway:redmond.litwareinc.com; or a string designating a per user rule. +A dial plan with the specified scope must already exist or the command will fail. -Default: +$1 (The default prefixes the number with a plus sign \[+\].) +The Parent parameter is required unless the Identity parameter is specified. +You cannot include the Identity parameter and the Parent parameter in the same command. +If you include the Parent parameter, the Name parameter is also required. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -250,14 +256,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Pattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +A regular expression that the dialed number must match in order for this rule to be applied. + +Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -266,17 +276,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. +### -Priority -For Lync or Skype for Business Server, if you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the -object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +The order in which rules are applied. +A phone number might match more than one rule. +This parameter sets the order in which the rules are tested against the number. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -285,27 +296,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Tenant -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +For internal Microsoft usage. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -314,14 +314,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Translation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +The regular expression pattern that will be applied to the number to convert it to E.164 format. + +Default: +$1 (The default prefixes the number with a plus sign \[+\].) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -330,14 +334,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal Microsoft usage. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/New-Team.md b/teams/teams-ps/MicrosoftTeams/New-Team.md similarity index 99% rename from teams/teams-ps/teams/New-Team.md rename to teams/teams-ps/MicrosoftTeams/New-Team.md index 5ca7ae7b5c..39b71f95da 100644 --- a/teams/teams-ps/teams/New-Team.md +++ b/teams/teams-ps/MicrosoftTeams/New-Team.md @@ -1,24 +1,18 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/new-team -title: New-Team schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: New-Team --- # New-Team ## SYNOPSIS This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. -Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. - -If you want these groups to appear in Outlook clients, you can use the [Set-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/set-unifiedgroup) cmdlet in the Exchange Powershell Module to disable the switch parameter `HiddenFromExchangeClientsEnabled` (-HiddenFromExchangeClientsEnabled:$false). - -Note: The Teams application may need to be open by an Owner for up to two hours before changes are reflected. - ## SYNTAX ### CreateTeam (Default) @@ -48,6 +42,12 @@ New-Team -GroupId [-Owner ] [-AllowGiphy ] [-GiphyCont ## DESCRIPTION Creates a new team with user specified settings, and returns a Group object with a GroupID property. +Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. + +If you want these groups to appear in Outlook clients, you can use the [Set-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/set-unifiedgroup) cmdlet in the Exchange Powershell Module to disable the switch parameter `HiddenFromExchangeClientsEnabled` (-HiddenFromExchangeClientsEnabled:$false). + +Note: The Teams application may need to be open by an Owner for up to two hours before changes are reflected. + ## EXAMPLES ### Example 1 @@ -79,109 +79,23 @@ This example creates a team, adds three members to it, and creates three channel ## PARAMETERS -### -MailNickName -The MailNickName parameter specifies the alias for the associated Office 365 Group. -This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. -The value of the MailNickName parameter has to be unique across your tenant. -Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. - -For more details about the naming conventions see here: [New-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Classification -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Team description. Characters Limit - 1024. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Team display name. Characters Limit - 256. - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Template -If you have an EDU license, you can use this parameter to specify which template you'd like to use for creating your group. -Do not use this parameter when converting an existing group. - -Valid values are: "EDU_Class" or "EDU_PLC" - -```yaml -Type: String -Parameter Sets: CreateTeam -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Owner -An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. -This user will be added as both a member and an owner of the group. -If not specified, the user who creates the team will be added as both a member and an owner. -Please note: This parameter is mandatory, if connected using Certificate Based Authentication. +### -AllowAddRemoveApps +Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) +Default value: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAddRemoveApps -Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. +### -AllowChannelMentions +Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. ```yaml Type: Boolean @@ -195,17 +109,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelMentions -Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. +### -AllowCreatePrivateChannels +Determines whether private channel creation is allowed for the team. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: CreateTeam Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -405,6 +319,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Classification +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Team description. Characters Limit - 1024. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DisplayName +Team display name. Characters Limit - 256. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -GiphyContentRating Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" @@ -436,8 +395,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Visibility -Set to Public to allow all users in your organization to join the group by default. Set to Private to require that an owner approve the join request. +### -MailNickName +The MailNickName parameter specifies the alias for the associated Office 365 Group. +This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. +The value of the MailNickName parameter has to be unique across your tenant. +Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. + +For more details about the naming conventions see here: [New-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. ```yaml Type: String @@ -446,23 +410,26 @@ Aliases: Required: False Position: Named -Default value: Private +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ShowInTeamsSearchAndSuggestions -Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. +### -Owner +An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. +This user will be added as both a member and an owner of the group. +If not specified, the user who creates the team will be added as both a member and an owner. +Please note: This parameter is mandatory, if connected using Certificate Based Authentication. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -481,18 +448,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreatePrivateChannels -Determines whether private channel creation is allowed for the team. +### -ShowInTeamsSearchAndSuggestions +Setting that determines whether or not private teams should be searchable from Teams clients for users who do not belong to that team. Set to $false to make those teams not discoverable from Teams clients. ```yaml Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Template +If you have an EDU license, you can use this parameter to specify which template you'd like to use for creating your group. +Do not use this parameter when converting an existing group. + +Valid values are: "EDU_Class" or "EDU_PLC" + +```yaml +Type: String Parameter Sets: CreateTeam Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Visibility +Set to Public to allow all users in your organization to join the group by default. Set to Private to require that an owner approve the join request. + +```yaml +Type: String +Parameter Sets: CreateTeam +Aliases: + +Required: False +Position: Named +Default value: Private +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/New-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/New-TeamChannel.md similarity index 96% rename from teams/teams-ps/teams/New-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/New-TeamChannel.md index 579b2c7209..c96d06f9d2 100644 --- a/teams/teams-ps/teams/New-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/New-TeamChannel.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/new-teamchannel -title: New-TeamChannel schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: New-TeamChannel --- # New-TeamChannel @@ -41,15 +41,16 @@ Create a private channel with display name as "Engineering" ## PARAMETERS -### -GroupId -GroupId of the team +### -Description +Channel description. +Channel description can be up to 1024 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) @@ -72,16 +73,15 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Description -Channel description. -Channel description can be up to 1024 characters. +### -GroupId +GroupId of the team ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) @@ -123,7 +123,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### GroupId, DisplayName, Description, MembershipType, Owner +### GroupId + +### DisplayName + +### Description + +### MembershipType + +### Owner ## OUTPUTS diff --git a/teams/teams-ps/teams/New-TeamsApp.md b/teams/teams-ps/MicrosoftTeams/New-TeamsApp.md similarity index 99% rename from teams/teams-ps/teams/New-TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/New-TeamsApp.md index 1ba731d7b5..ac8bacbece 100644 --- a/teams/teams-ps/teams/New-TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/New-TeamsApp.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-teamsapp -title: New-TeamsApp schema: 2.0.0 +title: New-TeamsApp --- # New-TeamsApp diff --git a/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber.md similarity index 94% rename from teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber.md index e2c1985c62..de76b6cabf 100644 --- a/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Register-CsOnlineDialInConferencingServiceNumber.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/register-csonlinedialinconferencingservicenumber applicable: Microsoft Teams -title: Register-CsOnlineDialInConferencingServiceNumber -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/register-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Register-CsOnlineDialInConferencingServiceNumber --- # Register-CsOnlineDialInConferencingServiceNumber ## SYNOPSIS -When you buy Audio Conferencing licenses, Microsoft is hosting your audio conferencing bridge for your organization. The audio conferencing bridge gives out dial-in phone numbers from different locations so that meeting organizers and participants can use them to join Microsoft Teams meetings using a phone. -In addition to the phone numbers already assigned to your conferencing bridge, you can get additional service numbers (toll and toll-free numbers used for audio conferencing) from other locations, and then assign them to the conferencing bridge so you can expand coverage for your users. The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. +The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. ## SYNTAX @@ -35,9 +36,12 @@ Register-CsOnlineDialInConferencingServiceNumber [-Instance] [!NOTE] -> Remove any associated resource accounts with [Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) before attempting to delete the Auto Attendant (AA). - ## SYNTAX ``` @@ -27,9 +26,12 @@ Remove-CsAutoAttendant -Identity [-Tenant ] [] ## DESCRIPTION The Remove-CsAutoAttendant cmdlet deletes an AA that is specified by the Identity parameter. +> [!NOTE] +> Remove any associated resource accounts with [Remove-CsOnlineApplicationInstanceAssociation](remove-csonlineapplicationinstanceassociation.md) before attempting to delete the Auto Attendant (AA). + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Remove-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" ``` diff --git a/teams/teams-ps/teams/Remove-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/Remove-CsCallQueue.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsCallQueue.md index b4138debb8..72e7ea5820 100644 --- a/teams/teams-ps/teams/Remove-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsCallQueue.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cscallqueue applicable: Microsoft Teams -title: Remove-CsCallQueue -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-cscallqueue +schema: 2.0.0 +title: Remove-CsCallQueue --- # Remove-CsCallQueue @@ -27,7 +28,7 @@ The Remove-CsCallQueue cmdlet deletes an existing Call Queue specified by the Id ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCallQueue -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` diff --git a/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Remove-CsCallingLineIdentity.md similarity index 97% rename from teams/teams-ps/teams/Remove-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsCallingLineIdentity.md index 0a95b6cbed..c6321d9637 100644 --- a/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity applicable: Microsoft Teams -title: Remove-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity +schema: 2.0.0 +title: Remove-CsCallingLineIdentity --- # Remove-CsCallingLineIdentity @@ -26,7 +27,7 @@ This cmdlet will remove a Caller ID policy from your organization or resets the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsCallingLineIdentity -Identity Anonymous ``` @@ -35,45 +36,45 @@ This example removes a Caller ID policy. ## PARAMETERS -### -Identity -The Identity parameter identifies the Caller ID policy. +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +### -Identity +The Identity parameter identifies the Caller ID policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: applicable: Microsoft Teams -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -WhatIf +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi applicable: Microsoft Teams Required: False diff --git a/teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/Remove-CsComplianceRecordingForCallQueueTemplate.md similarity index 93% rename from teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsComplianceRecordingForCallQueueTemplate.md index 8d0edf2cca..0c7fb2fa86 100644 --- a/teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsComplianceRecordingForCallQueueTemplate.md @@ -1,17 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsComplianceRecordingForCallQueueTemplate applicable: Microsoft Teams -title: Remove-CsComplianceRecordingForCallQueueTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: Remove-CsComplianceRecordingForCallQueueTemplate --- # Remove-CsComplianceRecordingForCallQueueTemplate +## SYNOPSIS +Use the Remove-CsComplianceRecordingForCallQueueTemplate cmdlet to delete a Compliance Recording for Call Queues template. + ## SYNTAX ```powershell @@ -26,7 +30,7 @@ Use the Remove-CsComplianceRecordingForCallQueueTemplate cmdlet to delete a Comp ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` diff --git a/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Remove-CsCustomPolicyPackage.md similarity index 97% rename from teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsCustomPolicyPackage.md index c5fbbf878d..de9d884220 100644 --- a/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsCustomPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: sunguchuan external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: Remove-CsCustomPolicyPackage -author: sunguchuan ms.author: gucsun -manager: dasosby online version: https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage schema: 2.0.0 +title: Remove-CsCustomPolicyPackage --- # Remove-CsCustomPolicyPackage @@ -38,13 +39,14 @@ Deletes a custom package named "MyPackage". ### -Identity +> Applicable: Microsoft Teams + The name of the custom package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None diff --git a/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsExternalAccessPolicy.md similarity index 87% rename from teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsExternalAccessPolicy.md index a801caa0bb..55c4925af2 100644 --- a/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsExternalAccessPolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy applicable: Microsoft Teams -title: Remove-CsExternalAccessPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy +schema: 2.0.0 +title: Remove-CsExternalAccessPolicy --- # Remove-CsExternalAccessPolicy ## SYNOPSIS Enables you to remove an existing external access policy. -External access policies determine whether or not your users can: 1) Communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) Communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Windows Live; 3) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop) and 4) Access Skype for Business Server over the Internet, without having to log on to your internal network. -This cmdlet was introduced in Lync Server 2010. ## SYNTAX @@ -25,6 +25,8 @@ Remove-CsExternalAccessPolicy [-Tenant ] [-Identity] [-Force ``` ## DESCRIPTION +This cmdlet was introduced in Lync Server 2010. + When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. @@ -53,7 +55,7 @@ Instead, the properties of the global policy will simply be reset to their defau ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsExternalAccessPolicy -Identity site:Redmond ``` @@ -61,7 +63,7 @@ Remove-CsExternalAccessPolicy -Identity site:Redmond In Example 1, the external access policy with the Identity site:Redmond is deleted. After the policy is removed, users in the Redmond site will have their external access permissions governed by the global policy. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsExternalAccessPolicy -Filter site:* | Remove-CsExternalAccessPolicy ``` @@ -70,7 +72,7 @@ Example 2 deletes all the external access policies that have been configured at To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of policies configured at the site scope; the filter value "site:*" limits the returned data to external access policies that have an Identity that begins with the string value "site:". The filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} | Remove-CsExternalAccessPolicy ``` @@ -80,7 +82,7 @@ To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet to r This collection is then piped to the `Where-Object` cmdlet, which picks out only those policies where the EnableFederationAccess property is equal to True. This filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -or $_.EnablePublicCloudAccess -eq $True} | Remove-CsExternalAccessPolicy ``` @@ -96,37 +98,34 @@ To delete all the policies where both EnableFederationAccess and EnablePublicClo ## PARAMETERS -### -Identity -Unique identifier for the external access policy to be removed. -External access policies can be configured at the global, site, or per-user scopes. -To "remove" the global policy, use this syntax: `-Identity global`. -(Note that the global policy cannot actually be removed. -Instead, all the properties in the global policy will be reset to their default values.) To remove a site policy, use syntax similar to this: `-Identity site:Redmond`. -To remove a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. +### -Confirm -Note that wildcards are not allowed when specifying an Identity. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -135,35 +134,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Unique identifier for the external access policy to be removed. +External access policies can be configured at the global, site, or per-user scopes. +To "remove" the global policy, use this syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. +Instead, all the properties in the global policy will be reset to their default values.) To remove a site policy, use syntax similar to this: `-Identity site:Redmond`. +To remove a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. -### -Confirm -Prompts you for confirmation before executing the command. +Note that wildcards are not allowed when specifying an Identity. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -189,6 +181,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md b/teams/teams-ps/MicrosoftTeams/Remove-CsGroupPolicyAssignment.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsGroupPolicyAssignment.md index db975cb1bc..34fd596d59 100644 --- a/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsGroupPolicyAssignment.md @@ -1,12 +1,13 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment -title: Remove-CsGroupPolicyAssignment -schema: 2.0.0 -author: tomkau ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment +schema: 2.0.0 +title: Remove-CsGroupPolicyAssignment --- # Remove-CsGroupPolicyAssignment @@ -54,47 +55,47 @@ In this example, the policy assignment with rank 2 is removed. As a result, the ## PARAMETERS -### -GroupId -The ID of the group from which the assignment will be removed. +### -Break +Wait for .NET debugger to attach ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyType -The policy type of the assignment to be removed from the group. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach +### -GroupId +The ID of the group from which the assignment will be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -144,6 +145,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyType +The policy type of the assignment to be removed from the group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Proxy The URI for the proxy server to use @@ -205,21 +221,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Remove-CsHybridTelephoneNumber.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsHybridTelephoneNumber.md index d08b9fba67..e32ab09377 100644 --- a/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsHybridTelephoneNumber.md @@ -1,14 +1,13 @@ --- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber applicable: Microsoft Teams author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: -title: Remove-CsHybridTelephoneNumber +online version: https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber schema: 2.0.0 +title: Remove-CsHybridTelephoneNumber --- # Remove-CsHybridTelephoneNumber @@ -16,9 +15,6 @@ schema: 2.0.0 ## SYNOPSIS This cmdlet removes a hybrid telephone number. -> [!IMPORTANT] -> This cmdlet is being deprecated. Use the new **New-CsOnlineTelephoneNumberReleaseOrder** cmdlet to remove a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineTelephoneNumberReleaseOrder](/powershell/module/teams/new-csonlinetelephonenumberreleaseorder?view=teams-ps). - ## SYNTAX ### Identity (Default) @@ -29,6 +25,9 @@ Remove-CsHybridTelephoneNumber -TelephoneNumber [-Force] [-WhatIf] [-Co ## DESCRIPTION This cmdlet removes a hybrid telephone number used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the new **New-CsOnlineTelephoneNumberReleaseOrder** cmdlet to remove a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineTelephoneNumberReleaseOrder](new-csonlinetelephonenumberreleaseorder.md). + ## EXAMPLES ### Example 1 @@ -39,16 +38,16 @@ This example removes the hybrid phone number +1 (402) 555-1234. ## PARAMETERS -### -TelephoneNumber -The telephone number to remove. The number should be specified without a prefixed "+". The phone number can't have "tel:" prefixed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -69,28 +68,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -TelephoneNumber + +> Applicable: Microsoft Teams + +The telephone number to remove. The number should be specified without a prefixed "+". The phone number can't have "tel:" prefixed. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: wi +Aliases: -Required: False -Position: Named +Required: True Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern.md index c41907981c..a7962e965a 100644 --- a/teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern applicable: Microsoft Teams -title: Remove-CsInboundBlockedNumberPattern author: serdarsoysal -ms.author: serdars -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern schema: 2.0.0 +title: Remove-CsInboundBlockedNumberPattern --- # Remove-CsInboundBlockedNumberPattern @@ -35,6 +36,21 @@ This example removes a blocked number pattern identified as "BlockAutomatic". ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity A unique identifier specifying the blocked number pattern to be removed. @@ -66,21 +82,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundExemptNumberPattern.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsInboundExemptNumberPattern.md index 2abeb0572b..49ecdfa323 100644 --- a/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern applicable: Microsoft Teams -title: Remove-CsInboundExemptNumberPattern -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern +schema: 2.0.0 +title: Remove-CsInboundExemptNumberPattern --- # Remove-CsInboundExemptNumberPattern @@ -35,6 +35,21 @@ This removes the exempt number patterns with Identity Exempt1. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier for the exempt number pattern to be listed. @@ -66,21 +81,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation.md similarity index 97% rename from teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation.md index 1fb51dfc00..14bf607be7 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation applicable: Microsoft Teams -title: Remove-CsOnlineApplicationInstanceAssociation -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation +schema: 2.0.0 +title: Remove-CsOnlineApplicationInstanceAssociation --- # Remove-CsOnlineApplicationInstanceAssociation @@ -28,7 +30,7 @@ This is useful when you want to associate this application instance with another ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Remove-CsOnlineApplicationInstanceAssociation -Identities "f7a821dc-2d69-5ae8-8525-bcb4a4556093" ``` diff --git a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioConferencingRoutingPolicy.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioConferencingRoutingPolicy.md index b9ca408b21..0484e9d7f6 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,128 +1,129 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudioconferencingroutingpolicy -title: Remove-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# Remove-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet deletes an instance of the Online Audio Conferencing Routing Policy. - -## SYNTAX - -```powershell -Remove-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. - -To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." - -The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. - -Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Remove-CsOnlineAudioConferencingRoutingPolicy -Identity "Test" -``` - -Deletes an Online Audio Conferencing Routing policy instance with the identity "Test". - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) -[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) -[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) -[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Remove-CsOnlineAudioConferencingRoutingPolicy +--- + +# Remove-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet deletes an instance of the Online Audio Conferencing Routing Policy. + +## SYNTAX + +```powershell +Remove-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsOnlineAudioConferencingRoutingPolicy -Identity "Test" +``` + +Deletes an Online Audio Conferencing Routing policy instance with the identity "Test". + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Remove-CsOnlineAudioFile.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioFile.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsOnlineAudioFile.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioFile.md index 61f7bace1f..1cfafafbe8 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineAudioFile.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineAudioFile.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile applicable: Microsoft Teams -title: Remove-CsOnlineAudioFile -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile +schema: 2.0.0 +title: Remove-CsOnlineAudioFile --- # Remove-CsOnlineAudioFile diff --git a/teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings.md similarity index 97% rename from teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings.md index 09faa588af..1e1b66c805 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineDialInConferencingTenantSettings.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinedialinconferencingtenantsettings applicable: Microsoft Teams -title: Remove-CsOnlineDialInConferencingTenantSettings -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinedialinconferencingtenantsettings +schema: 2.0.0 +title: Remove-CsOnlineDialInConferencingTenantSettings --- # Remove-CsOnlineDialInConferencingTenantSettings @@ -28,7 +30,7 @@ You can modify the settings using `Set-CsOnlineDialInConferencingTenantSettings` ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineDialInConferencingTenantSettings ``` @@ -37,29 +39,31 @@ This example reverts the tenant level dial-in conferencing settings to their ori ## PARAMETERS -### -Identity -This parameter is reserved for internal Microsoft use. +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams Required: False @@ -69,19 +73,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Identity +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisCivicAddress.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisCivicAddress.md index e78d109481..3ea616680d 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisCivicAddress.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress applicable: Microsoft Teams -title: Remove-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress +schema: 2.0.0 +title: Remove-CsOnlineLisCivicAddress --- # Remove-CsOnlineLisCivicAddress @@ -45,6 +46,9 @@ This example removes all the emergency civic addresses in the city of Redmond. ## PARAMETERS ### -CivicAddressId + +> Applicable: Microsoft Teams + Specifies the unique identifier of the civic address to be deleted. You can find civic address identifiers by using the Get-CsOnlineLisCivicAddress cmdlet. @@ -52,7 +56,6 @@ You can find civic address identifiers by using the Get-CsOnlineLisCivicAddress Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named @@ -61,16 +64,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf Required: False Position: Named @@ -79,15 +82,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. +### -Force + +> Applicable: Microsoft Teams + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -96,14 +102,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -WhatIf + +> Applicable: Microsoft Teams + +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisLocation.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisLocation.md index 4006964361..435675bd6f 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation applicable: Microsoft Teams -title: Remove-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation +schema: 2.0.0 +title: Remove-CsOnlineLisLocation --- # Remove-CsOnlineLisLocation @@ -37,31 +38,16 @@ This example removes the location specified by its identity. ## PARAMETERS -### -LocationId -Specifies the unique identifier of the location to be deleted. -Location identities can be discovered by using the Get-CsOnlineLisLocation cmdlet. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Confirm The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -71,6 +57,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -79,7 +68,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -88,7 +76,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationId + +> Applicable: Microsoft Teams + +Specifies the unique identifier of the location to be deleted. +Location identities can be discovered by using the Get-CsOnlineLisLocation cmdlet. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -96,7 +106,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisPort.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisPort.md similarity index 93% rename from teams/teams-ps/teams/Remove-CsOnlineLisPort.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisPort.md index 6e1665a058..77c6a6412c 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisPort.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisPort.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport applicable: Microsoft Teams -title: Remove-CsOnlineLisPort -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport +schema: 2.0.0 +title: Remove-CsOnlineLisPort --- # Remove-CsOnlineLisPort @@ -38,13 +39,15 @@ Example 1 removes the location information for port 12174 with ChassisID 0B-23-C ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -53,16 +56,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -PortID -This parameter identifies the ID of the port. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -70,6 +75,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -78,7 +86,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -88,13 +95,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -104,13 +113,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,30 +130,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore -This parameter is reserved for internal Microsoft use. +### -PortID + +> Applicable: Microsoft Teams + +This parameter identifies the ID of the port. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -152,6 +167,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -159,7 +177,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSubnet.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSubnet.md index eec633e37e..1b29b3094a 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSubnet.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelissubnet applicable: Microsoft Teams -title: Remove-CsOnlineLisSubnet -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelissubnet +schema: 2.0.0 +title: Remove-CsOnlineLisSubnet --- # Remove-CsOnlineLisSubnet @@ -26,14 +27,14 @@ Enhanced 9-1-1 (E9-1-1) allows an emergency operator to identify the location of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineLisSubnet -Subnet 10.10.10.10 ``` Example 1 removes the Location Information Service subnet "10.10.10.10". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Remove-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e ``` diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSwitch.md similarity index 93% rename from teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSwitch.md index be82fd7ba5..4eb245207a 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisSwitch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch applicable: Microsoft Teams -title: Remove-CsOnlineLisSwitch -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch +schema: 2.0.0 +title: Remove-CsOnlineLisSwitch --- # Remove-CsOnlineLisSwitch @@ -36,13 +37,15 @@ Example 1 removes the switch with Chassis ID "0B-23-CD-16-AA-CC". ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -51,7 +54,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -60,7 +84,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -70,13 +93,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -86,13 +111,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -102,13 +129,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -117,23 +146,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -141,7 +157,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint.md index ff2c7da4d7..c387785b62 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineLisWirelessAccessPoint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint applicable: Microsoft Teams -title: Remove-CsOnlineLisWirelessAccessPoint -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint +schema: 2.0.0 +title: Remove-CsOnlineLisWirelessAccessPoint --- # Remove-CsOnlineLisWirelessAccessPoint @@ -47,13 +48,15 @@ Example 2 removes the Location Information Server (LIS) wireless access point wi ## PARAMETERS ### -BSSID + +> Applicable: Microsoft Teams + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. It can be presented in wildcard format. The wildcard '*' can be on either the last one or two character(s). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -62,7 +65,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -71,7 +95,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -81,13 +104,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -97,13 +122,15 @@ Accept wildcard characters: False ``` ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -113,13 +140,15 @@ Accept wildcard characters: False ``` ### -TargetStore + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -128,23 +157,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -152,7 +168,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlinePSTNGateway.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlinePSTNGateway.md index 6af2287599..9a434dc6ba 100644 --- a/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlinePSTNGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway applicable: Microsoft Teams -title: Remove-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway +schema: 2.0.0 +title: Remove-CsOnlinePSTNGateway --- # Remove-CsOnlinePSTNGateway @@ -35,13 +36,15 @@ This example removes SBC with Identity (and FQDN) sbc.contoso.com. ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + The parameter is mandatory for the cmdlet. The Identity is the same as the SBC FQDN. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: True Position: 1 Default value: None diff --git a/teams/teams-ps/teams/Remove-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineSchedule.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineSchedule.md index 6dc49f8900..27b300b36c 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineschedule applicable: Microsoft Teams -title: Remove-CsOnlineSchedule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineschedule +schema: 2.0.0 +title: Remove-CsOnlineSchedule --- # Remove-CsOnlineSchedule @@ -25,7 +27,7 @@ The Remove-CsOnlineSchedule cmdlet deletes a schedule that is specified by using ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" ``` diff --git a/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineTelephoneNumber.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineTelephoneNumber.md index 4c26d98627..4d3e611893 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineTelephoneNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinetelephonenumber applicable: Microsoft Teams -title: Remove-CsOnlineTelephoneNumber -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinetelephonenumber +schema: 2.0.0 +title: Remove-CsOnlineTelephoneNumber --- # Remove-CsOnlineTelephoneNumber @@ -26,7 +27,7 @@ This cmdlet removes one or more unassigned telephone numbers from your tenant. I ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineTelephoneNumber -TelephoneNumber 14258884567 ``` @@ -38,7 +39,7 @@ NumberIdsDeleted NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManage This example removes the specified telephone number from the tenant. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` [string[]]$tns="+14255551234","+14255551233" Remove-CsOnlineTelephoneNumber -TelephoneNumber $tns @@ -54,28 +55,30 @@ This example removes the specified list of telephone numbers from the tenant. ## PARAMETERS -### -TelephoneNumber -Specifies the telephone number(s) to remove. The format can be with or without the prefixed +, but needs to include country code etc. +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml -Type: String[] +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -84,17 +87,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -TelephoneNumber +Specifies the telephone number(s) to remove. The format can be with or without the prefixed +, but needs to include country code etc. ```yaml -Type: SwitchParameter +Type: String[] Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoute.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoute.md index c2487ee802..927e0b8598 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute applicable: Microsoft Teams -title: Remove-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute +schema: 2.0.0 +title: Remove-CsOnlineVoiceRoute --- # Remove-CsOnlineVoiceRoute @@ -27,21 +28,21 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsOnlineVoiceRoute -Identity Route1 ``` Removes the settings for the online voice route with the identity Route1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\ Get-CsOnlineVoiceRoute | Remove-CsOnlineVoiceRoute ``` This command removes all online voice routes from the organization. First all online voice routes are retrieved by the `Get-CsOnlineVoiceRoute` cmdlet. These online voice routes are then piped to the `Remove-CsOnlineVoiceRoute` cmdlet, which removes each one. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\ Get-CsOnlineVoiceRoute -Filter *Redmond* | Remove-CsOnlineVoiceRoute ``` diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy.md index a92e803b2c..d8f432117b 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Remove-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Remove-CsOnlineVoiceRoutingPolicy --- # Remove-CsOnlineVoiceRoutingPolicy @@ -29,21 +30,21 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" ``` The command shown in Example 1 deletes the online voice routing policy RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy -Filter "tag:*" | Remove-CsOnlineVoiceRoutingPolicy ``` In Example 2, all the online voice routing policies configured at the per-user scope are removed. To do this, the command first calls the `Get-CsOnlineVoiceRoutingPolicy` cmdlet along with the Filter parameter; the filter value "tag:\*" limits the returned data to online voice routing policies configured at the per-user scope. Those per-user policies are then piped to and removed by, the `Remove-CsOnlineVoiceRoutingPolicy` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Long Distance"} | Remove-CsOnlineVoiceRoutingPolicy ``` @@ -52,6 +53,21 @@ In Example 3, all the online voice routing polices that include the online PSTN ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier assigned to the policy when it was created. @@ -83,21 +99,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy.md similarity index 97% rename from teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy.md index 37611ecdb3..18fb8f8646 100644 --- a/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsOnlineVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy applicable: Microsoft Teams -title: Remove-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy +schema: 2.0.0 +title: Remove-CsOnlineVoicemailPolicy --- # Remove-CsOnlineVoicemailPolicy @@ -26,7 +27,7 @@ Deletes an existing Online Voicemail policy or resets the Global policy instance ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" ``` @@ -34,45 +35,45 @@ The command shown in Example 1 deletes a per-user online voicemail policy Custom ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -Confirm +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi applicable: Microsoft Teams Required: False diff --git a/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberAssignment.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberAssignment.md index b49552c75f..5b304f250e 100644 --- a/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberAssignment.md @@ -1,162 +1,161 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment -applicable: Microsoft Teams -title: Remove-CsPhoneNumberAssignment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Remove-CsPhoneNumberAssignment - -## SYNOPSIS -This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). - -## SYNTAX - -### RemoveSome (Default) -```powershell -Remove-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType -Notify [] -``` - -### RemoveAll -```powershell -Remove-CsPhoneNumberAssignment -Identity -RemoveAll -Notify [] -``` - -## DESCRIPTION -This cmdlet removes/unassigns a phone number from a user or resource account. The phone number continues to be available in the tenant. - -Unassigning a phone number from a user or resource account will automatically set EnterpriseVoiceEnabled to False. - -If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a -Code string parameter and a Message string parameter with additional details of the failure. Email notification to end user is a best effort operation. No error message will be displayed if the email fails to send. - - -**Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an -exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also -now support the -ErrorAction parameter to control the execution after an error has occurred. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan -``` -This example removes/unassigns the Microsoft Calling Plan telephone number +1 (206) 555-1234 from the user user1@contoso.com. - -### Example 2 -```powershell -Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll -``` -This example removes/unassigns all the telephone number from user2@contoso.com. - -### Example 3 -```powershell -Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan -Notify -``` -This example removes/unassigns the Microsoft Calling Plan phone number +1 (206) 555-1234 from the user user1@contoso.com and also sends an email notification to the user about the removal of telephone number. - -### Example 4 -```powershell -Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll -Notify -``` -This example removes/unassigns all the telephone number from user2@contoso.com and also sends an email notification to the user about the change. - -## PARAMETERS - -### -Identity -The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or -resource account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -The phone number to unassign from the user or resource account. Supports E.164 format and non-E.164 format. Needs to be without the prefixed "tel:". - -```yaml -Type: System.String -Parameter Sets: (RemoveSome) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumberType -The type of phone number to unassign from the user or resource account. The supported values are DirectRouting, CallingPlan and OperatorConnect. - -```yaml -Type: System.String -Parameter Sets: (RemoveSome) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveAll -Unassigns the phone number from the user or resource account. - -```yaml -Type: Switch -Parameter Sets: (RemoveAll) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notify -Sends a best-effort email notification when a phone number is removed. Failures to send email are not reported. - -```yaml -Type: Switch -Parameter Sets: (RemoveSome, RemoveAll) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 3.0.0 or later. - -The cmdlet is only available in commercial and GCC cloud instances. - -## RELATED LINKS -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) - -[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment +schema: 2.0.0 +title: Remove-CsPhoneNumberAssignment +--- + +# Remove-CsPhoneNumberAssignment + +## SYNOPSIS +This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). + +## SYNTAX + +### RemoveSome (Default) +```powershell +Remove-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType -Notify [] +``` + +### RemoveAll +```powershell +Remove-CsPhoneNumberAssignment -Identity -RemoveAll -Notify [] +``` + +## DESCRIPTION +This cmdlet removes/unassigns a phone number from a user or resource account. The phone number continues to be available in the tenant. + +Unassigning a phone number from a user or resource account will automatically set EnterpriseVoiceEnabled to False. + +If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a +Code string parameter and a Message string parameter with additional details of the failure. Email notification to end user is a best effort operation. No error message will be displayed if the email fails to send. + + +**Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an +exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also +now support the -ErrorAction parameter to control the execution after an error has occurred. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan +``` +This example removes/unassigns the Microsoft Calling Plan telephone number +1 (206) 555-1234 from the user user1@contoso.com. + +### Example 2 +```powershell +Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll +``` +This example removes/unassigns all the telephone number from user2@contoso.com. + +### Example 3 +```powershell +Remove-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan -Notify +``` +This example removes/unassigns the Microsoft Calling Plan phone number +1 (206) 555-1234 from the user user1@contoso.com and also sends an email notification to the user about the removal of telephone number. + +### Example 4 +```powershell +Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll -Notify +``` +This example removes/unassigns all the telephone number from user2@contoso.com and also sends an email notification to the user about the change. + +## PARAMETERS + +### -Identity +The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or +resource account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notify +Sends a best-effort email notification when a phone number is removed. Failures to send email are not reported. + +```yaml +Type: Switch +Parameter Sets: (RemoveSome, RemoveAll) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumber +The phone number to unassign from the user or resource account. Supports E.164 format and non-E.164 format. Needs to be without the prefixed "tel:". + +```yaml +Type: System.String +Parameter Sets: (RemoveSome) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumberType +The type of phone number to unassign from the user or resource account. The supported values are DirectRouting, CallingPlan and OperatorConnect. + +```yaml +Type: System.String +Parameter Sets: (RemoveSome) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAll +Unassigns the phone number from the user or resource account. + +```yaml +Type: Switch +Parameter Sets: (RemoveAll) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 3.0.0 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) + +[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Remove-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberTag.md similarity index 97% rename from teams/teams-ps/teams/Remove-CsPhoneNumberTag.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberTag.md index 38cda0282c..52b5f2ffb9 100644 --- a/teams/teams-ps/teams/Remove-CsPhoneNumberTag.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsPhoneNumberTag.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/remove-csphonenumbertag applicable: Microsoft Teams -title: Remove-CsPhoneNumberTag author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/teams/remove-csphonenumbertag schema: 2.0.0 +title: Remove-CsPhoneNumberTag --- # Remove-CsPhoneNumberTag diff --git a/teams/teams-ps/teams/Remove-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/Remove-CsSharedCallQueueHistoryTemplate.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsSharedCallQueueHistoryTemplate.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsSharedCallQueueHistoryTemplate.md index b50b153b93..e35ceba718 100644 --- a/teams/teams-ps/teams/Remove-CsSharedCallQueueHistoryTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsSharedCallQueueHistoryTemplate.md @@ -1,20 +1,24 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsSharedCallQueueHistoryTemplate applicable: Microsoft Teams -title: Remove-CsSharedCallQueueHistoryTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: Remove-CsSharedCallQueueHistoryTemplate --- # Remove-CsSharedCallQueueHistoryTemplate +## SYNOPSIS +Deletes a Shared Call Queue History template. + ## SYNTAX -```powershell +``` Remove-CsSharedCallQueueHistoryTemplate -Id [] ``` @@ -26,7 +30,7 @@ Use the Remove-CsSharedCallQueueHistoryTemplate cmdlet to delete a Shared Call Q ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsSharedCallQueueHistoryTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 ``` diff --git a/teams/teams-ps/teams/Remove-CsTeamTemplate.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamTemplate.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamTemplate.md index ee73ec6d3d..05f9553b96 100644 --- a/teams/teams-ps/teams/Remove-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamTemplate.md @@ -1,273 +1,276 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate -title: Remove-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: farahf -schema: 2.0.0 ---- - -# Remove-CsTeamTemplate - -## SYNOPSIS - -This cmdlet deletes a specified Team Template from Microsoft Teams. - -## SYNTAX - -### Delete (Default) - -```powershell -Remove-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### DeleteViaIdentity - -```powershell -Remove-CsTeamTemplate -InputObject [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> Remove-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US' -``` - -Removes template with OData Id '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US'. - -### EXAMPLE 2 - -```powershell -PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Remove-CsTeamTemplate -OdataId $_.OdataId} -``` - -Removes template that meets the following specifications: 1) Locale set to en-US. 2) Name contains 'test'. - -## PARAMETERS - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OdataId - -A composite URI of a template. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IAny - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - -- `[Bssid ]`: -- `[ChassisId ]`: -- `[CivicAddressId ]`: Civic address id. -- `[Country ]`: -- `[GroupId ]`: The ID of a group whose policy assignments will be returned. -- `[Id ]`: -- `[Identity ]`: -- `[Locale ]`: -- `[LocationId ]`: Location id. -- `[OdataId ]`: A composite URI of a template. -- `[OperationId ]`: The ID of a batch policy assignment operation. -- `[OrderId ]`: -- `[PackageName ]`: The name of a specific policy package -- `[PolicyType ]`: The policy type for which group policy assignments will be returned. -- `[Port ]`: -- `[PortInOrderId ]`: -- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. -- `[SubnetId ]`: -- `[TenantId ]`: -- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -## RELATED LINKS - -[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) - -[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) - -[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) - -[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) - -[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: farahf +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate +schema: 2.0.0 +title: Remove-CsTeamTemplate +--- + +# Remove-CsTeamTemplate + +## SYNOPSIS +This cmdlet deletes a specified Team Template from Microsoft Teams. + +## SYNTAX + +### Delete (Default) + +``` +Remove-CsTeamTemplate -OdataId [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity + +``` +Remove-CsTeamTemplate -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet deletes a specified Team Template from Microsoft Teams. The template can be identified by its OData ID or by using the Identity parameter. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> Remove-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US' +``` + +Removes template with OData Id '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US'. + +### EXAMPLE 2 + +```powershell +PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Remove-CsTeamTemplate -OdataId $_.OdataId} +``` + +Removes template that meets the following specifications: 1) Locale set to en-US. 2) Name contains 'test'. + +## PARAMETERS + +### -Break + +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend + +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend + +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OdataId + +A composite URI of a template. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy + +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential + +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials + +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IAny + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT \: Identity Parameter + +- `[Bssid ]`: +- `[ChassisId ]`: +- `[CivicAddressId ]`: Civic address id. +- `[Country ]`: +- `[GroupId ]`: The ID of a group whose policy assignments will be returned. +- `[Id ]`: +- `[Identity ]`: +- `[Locale ]`: +- `[LocationId ]`: Location id. +- `[OdataId ]`: A composite URI of a template. +- `[OperationId ]`: The ID of a batch policy assignment operation. +- `[OrderId ]`: +- `[PackageName ]`: The name of a specific policy package +- `[PolicyType ]`: The policy type for which group policy assignments will be returned. +- `[Port ]`: +- `[PortInOrderId ]`: +- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. +- `[SubnetId ]`: +- `[TenantId ]`: +- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +## RELATED LINKS + +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) + +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) + +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) + +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) + +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAIPolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAIPolicy.md index 01ddbc1bcc..13b63c6611 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: Andy447 external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Remove-CsTeamsAIPolicy +ms.author: andywang online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsAIPolicy schema: 2.0.0 -author: Andy447 -ms.author: andywang +title: Remove-CsTeamsAIPolicy --- # Remove-CsTeamsAIPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy.md similarity index 78% rename from teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy.md index 409570c300..0b30aa9be3 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppPermissionPolicy.md @@ -1,26 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsapppermissionpolicy applicable: Microsoft Teams -title: Remove-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: mhayrapetyan +author: ashishguptaiitb +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: prkosh +Module Name: MicrosoftTeams ms.author: prkosh -author: ashishguptaiitb +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsapppermissionpolicy +schema: 2.0.0 +title: Remove-CsTeamsAppPermissionPolicy --- # Remove-CsTeamsAppPermissionPolicy ## SYNOPSIS - -**NOTE**: You can use this cmdlet to remove a specific custom policy from a user. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. - -As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . - -This cmdlet allows you to remove app permission policies that have been created within your organization. If you run `Remove-CsTeamsAppPermissionPolicy` on the Global policy, it will be reset to the defaults provided for new organizations. - -**This is only applicable for tenants who have not been migrated to ACM or UAM.** +This cmdlet allows you to remove app permission policies that have been created within your organization. ## SYNTAX @@ -36,6 +31,8 @@ As an admin, you can use app permission policies to enable or block specific app This cmdlet allows you to remove app permission policies that have been created within your organization. If you run Remove-CsTeamsAppPermissionPolicy on the Global policy, it will be reset to the defaults provided for new organizations. +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + ## EXAMPLES ### Example 1 @@ -47,22 +44,19 @@ Deletes a custom policy that has already been created in the organization. ## PARAMETERS -### -Identity -Unique identifier for the policy to be removed. -To "remove" the global policy, use the following syntax: `-Identity global`. -(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. -You cannot use wildcards when specifying a policy Identity. +### -Confirm +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -82,29 +76,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity +Unique identifier for the policy to be removed. +To "remove" the global policy, use the following syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. +You cannot use wildcards when specifying a policy Identity. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi +Aliases: applicable: Microsoft Teams -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams Required: False @@ -114,13 +111,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi applicable: Microsoft Teams Required: False diff --git a/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy.md similarity index 77% rename from teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy.md index fa290e6383..c42a6ab768 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAppSetupPolicy.md @@ -1,25 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsappsetuppolicy applicable: Microsoft Teams -title: Remove-CsTeamsAppSetupPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsappsetuppolicy +schema: 2.0.0 +title: Remove-CsTeamsAppSetupPolicy --- # Remove-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: You can use this cmdlet to remove custom app setup policies. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -If you run Remove-CsTeamsAppSetupPolicy on the Global policy, it will be reset to the defaults provided for new organizations. +You can use this cmdlet to remove custom app setup policies. ## SYNTAX @@ -48,22 +44,19 @@ Deletes a custom policy that has already been created in the organization. ## PARAMETERS -### -Identity -Unique identifier for the policy to be removed. -To "remove" the global policy, use the following syntax: `-Identity global`. -(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. -You cannot use wildcards when specifying a policy Identity. +### -Confirm +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -83,29 +76,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity +Unique identifier for the policy to be removed. +To "remove" the global policy, use the following syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. +You cannot use wildcards when specifying a policy Identity. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi +Aliases: applicable: Microsoft Teams -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams Required: False @@ -115,13 +111,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi applicable: Microsoft Teams Required: False diff --git a/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy.md index 5866a31e39..dafb89686a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy -title: Remove-CsTeamsAudioConferencingPolicy schema: 2.0.0 +title: Remove-CsTeamsAudioConferencingPolicy --- # Remove-CsTeamsAudioConferencingPolicy @@ -32,6 +33,21 @@ In the example shown above, the command will delete the "Emea Users" audio confe ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. Suppresses any confirmation prompts that would otherwise be displayed before making changes. @@ -63,21 +79,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy.md index e735cc0dc3..874c8c1746 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy applicable: Microsoft Teams -title: Remove-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy +schema: 2.0.0 +title: Remove-CsTeamsCallHoldPolicy --- # Remove-CsTeamsCallHoldPolicy @@ -48,18 +49,18 @@ The Filter value "Tag:*" limits the returned data to Teams call hold policies co ## PARAMETERS -### -Identity -Unique identifier of the Teams call hold policy to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -78,29 +79,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity +Unique identifier of the Teams call hold policy to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallParkPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallParkPolicy.md index 8504928e7c..78efa709d5 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallParkPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallparkpolicy applicable: Microsoft Teams -title: Remove-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallparkpolicy +schema: 2.0.0 +title: Remove-CsTeamsCallParkPolicy --- # Remove-CsTeamsCallParkPolicy @@ -39,22 +41,19 @@ Deletes a custom policy that has already been created in the organization. ## PARAMETERS -### -Identity -Unique identifier for the client policy to be removed. -To "remove" the global policy, use the following syntax: `-Identity global`. -(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. -You cannot use wildcards when specifying a policy Identity. +### -Confirm +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -74,29 +73,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity +Unique identifier for the client policy to be removed. +To "remove" the global policy, use the following syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. +You cannot use wildcards when specifying a policy Identity. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi +Aliases: applicable: Microsoft Teams -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams Required: False @@ -106,13 +108,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi applicable: Microsoft Teams Required: False diff --git a/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallingPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallingPolicy.md index f22acb63d5..1798375e44 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCallingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy schema: 2.0.0 +title: Remove-CsTeamsCallingPolicy --- # Remove-CsTeamsCallingPolicy @@ -41,33 +42,33 @@ This example resets the Global Policy instance to the default values. ## PARAMETERS -### -Identity - The Identity parameter is the unique identifier of the Teams Calling Policy instance to remove or reset. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity + The Identity parameter is the unique identifier of the Teams Calling Policy instance to remove or reset. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsChannelsPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsChannelsPolicy.md index 1adb7d3231..be8b72d7ac 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsChannelsPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy applicable: Microsoft Teams -title: Remove-CsTeamsChannelsPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy +schema: 2.0.0 +title: Remove-CsTeamsChannelsPolicy --- # Remove-CsTeamsChannelsPolicy @@ -39,26 +41,6 @@ Deletes a custom policy that has already been created in the organization. ## PARAMETERS -### -Identity -The name of the policy to be removed. Wildcards are not supported. - -To remove a custom policy, use syntax similar to this: `-Identity "Student Policy"`. - -To "remove" the global policy, use the following syntax: `-Identity Global`. You can't actually remove the global policy. Instead, all properties will be reset to their default values as shown in the default policy (`Tag:Default`). - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before executing the command. @@ -91,6 +73,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +The name of the policy to be removed. Wildcards are not supported. + +To remove a custom policy, use syntax similar to this: `-Identity "Student Policy"`. + +To "remove" the global policy, use the following syntax: `-Identity Global`. You can't actually remove the global policy. Instead, all properties will be reset to their default values as shown in the default policy (`Tag:Default`). + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Tenant Internal Microsoft use only. diff --git a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication.md index 05cb425285..ae024cb530 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication applicable: Microsoft Teams -title: Remove-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication +schema: 2.0.0 +title: Remove-CsTeamsComplianceRecordingApplication --- # Remove-CsTeamsComplianceRecordingApplication @@ -55,6 +56,36 @@ The command shown in Example 2 deletes all existing associations between applica ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity A name that uniquely identifies the application instance of the policy-based recording application. @@ -100,36 +131,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy.md index c121ab2692..5c048f87b4 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsComplianceRecordingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: Remove-CsTeamsComplianceRecordingPolicy --- # Remove-CsTeamsComplianceRecordingPolicy @@ -56,6 +57,36 @@ The Filter value "Tag:*" limits the returned data to Teams recording policies co ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier to be assigned to the new Teams recording policy. @@ -99,36 +130,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCortanaPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCortanaPolicy.md index bac8a3df1d..bf6621fc9c 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy applicable: Microsoft Teams -title: Remove-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +schema: 2.0.0 +title: Remove-CsTeamsCortanaPolicy --- # Remove-CsTeamsCortanaPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCustomBannerText.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCustomBannerText.md index 8619d8cca2..eac3941298 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsCustomBannerText.md @@ -1,16 +1,16 @@ --- +author: saleens7 +Locale: en-US Module Name: MicrosoftTeams +ms.author: wblocker online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText -title: Remove-CsTeamsCustomBannerText schema: 2.0.0 -author: saleens7 -ms.author: wblocker +title: Remove-CsTeamsCustomBannerText --- # Remove-CsTeamsCustomBannerText ## SYNOPSIS - Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call. ## SYNTAX @@ -27,6 +27,7 @@ Removes a single instance of custom banner text. ## EXAMPLES ### Example 1 +```powershell PS C:\> Remove-CsTeamsCustomBannerText -Identity CustomText ``` @@ -35,13 +36,15 @@ This example removes a TeamsCustomBannerText instance with the name "CustomText" ## PARAMETERS ### -Identity + +> Applicable: Microsoft Teams + Policy instance name (optional). ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None diff --git a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy.md index 09e839d382..359637ec73 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Remove-CsTeamsEmergencyCallRoutingPolicy --- # Remove-CsTeamsEmergencyCallRoutingPolicy @@ -42,6 +44,21 @@ This example resets the Teams Emergency Call Routing Global policy instance to i ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The Identity parameter is the unique identifier of the Teams Emergency Call Routing policy to remove. @@ -73,21 +90,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy.md index 0f35301904..e847530bc0 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy schema: 2.0.0 +title: Remove-CsTeamsEmergencyCallingPolicy --- # Remove-CsTeamsEmergencyCallingPolicy @@ -41,6 +43,21 @@ This example resets the Global Policy instance to the default values. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The Identity parameter is the unique identifier of the Teams Emergency Calling policy to remove. @@ -72,21 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEnhancedEncryptionPolicy.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEnhancedEncryptionPolicy.md index 2e310c4d61..12e2b5ff9b 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEnhancedEncryptionPolicy.md @@ -1,128 +1,129 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy -title: Remove-CsTeamsEnhancedEncryptionPolicy -author: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Remove-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Use this cmdlet to remove an existing Teams enhanced encryption policy. - -## SYNTAX - -``` -Remove-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Use this cmdlet to remove an existing Teams enhanced encryption policy. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> Remove-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerTeamsEnhancedEncryptionPolicy' -``` - -The command shown in Example 1 deletes the Teams enhanced encryption policy ContosoPartnerTeamsEnhancedEncryptionPolicy. - -### EXAMPLE 2 -```PowerShell -PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Filter 'Tag:*' | Remove-CsTeamsEnhancedEncryptionPolicy -``` - -In Example 2, all the Teams enhanced encryption policies configured at the per-user scope are removed. The Filter value "Tag:*" limits the returned data to Teams enhanced encryption policies configured at the per-user scope. Those per-user policies are then removed. - -## PARAMETERS - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Suppresses all non-fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Remove-CsTeamsEnhancedEncryptionPolicy +--- + +# Remove-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Use this cmdlet to remove an existing Teams enhanced encryption policy. + +## SYNTAX + +``` +Remove-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Use this cmdlet to remove an existing Teams enhanced encryption policy. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> Remove-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerTeamsEnhancedEncryptionPolicy' +``` + +The command shown in Example 1 deletes the Teams enhanced encryption policy ContosoPartnerTeamsEnhancedEncryptionPolicy. + +### EXAMPLE 2 +```PowerShell +PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Filter 'Tag:*' | Remove-CsTeamsEnhancedEncryptionPolicy +``` + +In Example 2, all the Teams enhanced encryption policies configured at the per-user scope are removed. The Filter value "Tag:*" limits the returned data to Teams enhanced encryption policies configured at the per-user scope. Those per-user policies are then removed. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) + +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEventsPolicy.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEventsPolicy.md index adc94c0242..272879affc 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsEventsPolicy.md @@ -1,94 +1,95 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamseventspolicy -title: Remove-CsTeamsEventsPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsEventsPolicy - -## SYNOPSIS -The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. - -## SYNTAX - -``` -Remove-CsTeamsEventsPolicy [-Identity] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Deletes a previously created TeamsEventsPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsEventsPolicy -Identity DisablePublicWebinars -``` - -In this example, the command will delete the DisablePublicWebinars policy from the organization's list of policies. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamseventspolicy +schema: 2.0.0 +title: Remove-CsTeamsEventsPolicy +--- + +# Remove-CsTeamsEventsPolicy + +## SYNOPSIS +The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. + +## SYNTAX + +``` +Remove-CsTeamsEventsPolicy [-Identity] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Deletes a previously created TeamsEventsPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsEventsPolicy -Identity DisablePublicWebinars +``` + +In this example, the command will delete the DisablePublicWebinars policy from the organization's list of policies. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy.md index c001e0e880..dbe74886a7 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFeedbackPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsfeedbackpolicy applicable: Microsoft Teams -title: Remove-CsTeamsFeedbackPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsfeedbackpolicy +schema: 2.0.0 +title: Remove-CsTeamsFeedbackPolicy --- # Remove-CsTeamsFeedbackPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFilesPolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFilesPolicy.md index 8b2f609c8e..3af010a539 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsFilesPolicy.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy -title: Remove-CsTeamsFilesPolicy schema: 2.0.0 +title: Remove-CsTeamsFilesPolicy --- # Remove-CsTeamsFilesPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy.md index f31fdeafd5..8da4389fb0 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsipphonepolicy applicable: Microsoft Teams -title: Remove-CsTeamsIPPhonePolicy author: tonywoodruff +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsipphonepolicy schema: 2.0.0 +title: Remove-CsTeamsIPPhonePolicy --- # Remove-CsTeamsIPPhonePolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMediaConnectivityPolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMediaConnectivityPolicy.md index a2b3b79a34..daac8412c2 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: lirunping-MSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Remove-CsTeamsMediaConnectivityPolicy +ms.author: runli online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMediaConnectivityPolicy schema: 2.0.0 -author: lirunping-MSFT -ms.author: runli +title: Remove-CsTeamsMediaConnectivityPolicy --- # Remove-CsTeamsMediaConnectivityPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy.md index ac3f34c82e..5242276a57 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBrandingPolicy.md @@ -1,13 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Remove-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas --- # Remove-CsTeamsMeetingBrandingPolicy @@ -35,20 +35,6 @@ In this example, the command deletes the `policy test` meeting branding policy f ## PARAMETERS -### -Identity -Unique identifier of the policy to be deleted. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -79,6 +65,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Unique identifier of the policy to be deleted. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -WhatIf Describes what would happen if you executed the command without actually executing the command. diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy.md similarity index 91% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy.md index 3b8ee0ebd4..a46d694095 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingBroadcastPolicy.md @@ -1,19 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbroadcastpolicy applicable: Microsoft Teams -title: Remove-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Remove-CsTeamsMeetingBroadcastPolicy --- # Remove-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS -Remove-CsTeamsMeetingBroadcastPolicy \[-Identity\] \ \[-Tenant \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] +Deletes an existing Teams meeting broadcast policy in your tenant. ## SYNTAX @@ -23,7 +25,7 @@ Remove-CsTeamsMeetingBroadcastPolicy [-Tenant ] [-Identity] ``` ## DESCRIPTION -User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to delete an existing policy. +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## EXAMPLES diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingPolicy.md index afc4b6bca6..4ece4769df 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingpolicy +schema: 2.0.0 +title: Remove-CsTeamsMeetingPolicy --- # Remove-CsTeamsMeetingPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md index b813ff072b..f32ebd6b94 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Remove-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Remove-CsTeamsMeetingTemplatePermissionPolicy --- # Remove-CsTeamsMeetingTemplatePermissionPolicy @@ -54,13 +55,14 @@ At line:1 char:1 ### -Identity +> Applicable: Microsoft Teams + Identity of the policy instance to be deleted. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMessagingPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMessagingPolicy.md index 1529b4300f..731f58b617 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMessagingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmessagingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsMessagingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmessagingpolicy +schema: 2.0.0 +title: Remove-CsTeamsMessagingPolicy --- # Remove-CsTeamsMessagingPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMobilityPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMobilityPolicy.md index 8cce132f98..20caebefff 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmobilitypolicy applicable: Microsoft Teams -title: Remove-CsTeamsMobilityPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmobilitypolicy +schema: 2.0.0 +title: Remove-CsTeamsMobilityPolicy --- # Remove-CsTeamsMobilityPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy.md index 5192c02bc6..e7239a89f9 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnetworkroamingpolicy applicable: Microsoft Teams -title: Remove-CsTeamsNetworkRoamingPolicy author: TristanChen-msft -ms.author: jiaych -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnetworkroamingpolicy schema: 2.0.0 +title: Remove-CsTeamsNetworkRoamingPolicy --- # Remove-CsTeamsNetworkRoamingPolicy @@ -32,7 +32,7 @@ More on the impact of bit rate setting on bandwidth can be found [here](https:// ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsTeamsNetworkRoamingPolicy -Identity OfficePolicy ``` diff --git a/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNotificationAndFeedsPolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNotificationAndFeedsPolicy.md index 172211f455..d55317b612 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsNotificationAndFeedsPolicy.md @@ -1,109 +1,110 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnotificationandfeedspolicy -title: Remove-CsTeamsNotificationAndFeedsPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsNotificationAndFeedsPolicy - -## SYNOPSIS -Deletes an existing Teams Notification and Feeds Policy - -## SYNTAX - -```powershell -Remove-CsTeamsNotificationAndFeedsPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsNotificationAndFeedsPolicy -``` - -Remove an existing Notifications and Feeds Policy - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the policy when it was created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnotificationandfeedspolicy +schema: 2.0.0 +title: Remove-CsTeamsNotificationAndFeedsPolicy +--- + +# Remove-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS +Deletes an existing Teams Notification and Feeds Policy + +## SYNTAX + +```powershell +Remove-CsTeamsNotificationAndFeedsPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsNotificationAndFeedsPolicy +``` + +Remove an existing Notifications and Feeds Policy + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRecordingRollOutPolicy.md similarity index 97% rename from teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRecordingRollOutPolicy.md index 6a51b6ae29..1801ba1c79 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- +applicable: Microsoft Teams +author: ronwa external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams +ms.author: ronwa online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsrecordingrolloutpolicy schema: 2.0.0 -applicable: Microsoft Teams title: Remove-CsTeamsRecordingRollOutPolicy -manager: yujin1 -author: ronwa -ms.author: ronwa --- # Remove-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md index e1a8839e41..64ac67dc50 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,107 +1,110 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsroomvideoteleconferencingpolicy -title: Remove-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Deletes an existing TeamsRoomVideoTeleConferencingPolicy. - -## SYNTAX - -```powershell -Remove-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the policy to be modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Remove-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Remove-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Deletes an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +``` +Remove-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSharedCallingRoutingPolicy.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSharedCallingRoutingPolicy.md index 536843d50b..3ca426f684 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSharedCallingRoutingPolicy.md @@ -1,14 +1,13 @@ --- +applicable: Microsoft Teams +author: serdarsoysal external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy -applicable: Microsoft Teams -title: Remove-CsTeamsSharedCallingRoutingPolicy schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: +title: Remove-CsTeamsSharedCallingRoutingPolicy --- # Remove-CsTeamsSharedCallingRoutingPolicy @@ -44,29 +43,31 @@ and removed by the Remove-CsTeamsSharedCallingRoutingPolicy cmdlet. ## PARAMETERS -### -Identity -Unique identifier assigned to the policy when it is created. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -75,29 +76,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity +Unique identifier assigned to the policy when it is created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnection.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnection.md index a86968dfd2..392a000d62 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: stepfitz Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: stepfitz online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnection schema: 2.0.0 +title: Remove-CsTeamsShiftsConnection --- # Remove-CsTeamsShiftsConnection @@ -38,13 +39,14 @@ Deletes the connection with ID `43cd0e23-b62d-44e8-9321-61cb5fcfae85`. ### -ConnectionId +> Applicable: Microsoft Teams + The ID of the connection that you want to delete. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionInstance.md similarity index 97% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionInstance.md index 843cf262ce..635d70c095 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsConnectionInstance -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Remove-CsTeamsShiftsConnectionInstance --- # Remove-CsTeamsShiftsConnectionInstance @@ -38,13 +39,14 @@ Deletes the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8 ### -ConnectorInstanceId +> Applicable: Microsoft Teams + The ID of the connection instance that you want to delete. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionTeamMap.md similarity index 97% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionTeamMap.md index 48935f7bec..cb9637a10a 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsConnectionTeamMap.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsConnectionTeamMap -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectionteammap schema: 2.0.0 +title: Remove-CsTeamsShiftsConnectionTeamMap --- # Remove-CsTeamsShiftsConnectionTeamMap @@ -38,21 +39,7 @@ Unmaps the Teams team with ID "30b625bd-f0f7-4d5c-8793-9ccef5a63119" in the inst ### -ConnectorInstanceId -The ID of the connection instance that you want to delete. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamId +> Applicable: Microsoft Teams The ID of the connection instance that you want to delete. @@ -60,7 +47,6 @@ The ID of the connection instance that you want to delete. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -100,6 +86,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamId + +> Applicable: Microsoft Teams + +The ID of the connection instance that you want to delete. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsPolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsPolicy.md index f7201e43a2..a535df6727 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsPolicy.md @@ -1,70 +1,73 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsshiftspolicy -title: Remove-CsTeamsShiftsPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsShiftsPolicy - -## SYNOPSIS - -The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. - -Note: A TeamsShiftsPolicy needs to be unassigned from all the users before it can be deleted. - -## SYNTAX - -``` -Remove-CsTeamsShiftsPolicy [-Identity] [] -``` - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -``` - -In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". - -## PARAMETERS - -### -Identity -Policy instance name. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsshiftspolicy +schema: 2.0.0 +title: Remove-CsTeamsShiftsPolicy +--- + +# Remove-CsTeamsShiftsPolicy + +## SYNOPSIS +The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. + +## SYNTAX + +``` +Remove-CsTeamsShiftsPolicy [-Identity] [] +``` + +## DESCRIPTION +Note: A TeamsShiftsPolicy needs to be unassigned from all the users before it can be deleted. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage +``` + +In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". + +## PARAMETERS + +### -Identity + +> Applicable: Microsoft Teams + +Policy instance name. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) + +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsScheduleRecord.md similarity index 97% rename from teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsScheduleRecord.md index 5c64fec405..7828ec5a32 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsShiftsScheduleRecord.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Remove-CsTeamsShiftsScheduleRecord -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsschedulerecord schema: 2.0.0 +title: Remove-CsTeamsShiftsScheduleRecord --- # Remove-CsTeamsShiftsScheduleRecord @@ -47,29 +48,29 @@ Removes the Shifts schedule record of swapRequest and openShiftRequest scenarios ## PARAMETERS -### -ClearSchedulingGroup -A value indicating whether to clear schedule group. +### -Body +The request body. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: IClearScheduleRequest +Parameter Sets: Remove Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -DateRangeEndDate -The end date of removing schedule record. +### -Break +Wait for .NET debugger to attach. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + Required: False Position: Named Default value: None @@ -77,29 +78,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DateRangeStartDate -The start date of removing schedule record. +### -ClearSchedulingGroup + +> Applicable: Microsoft Teams + +A value indicating whether to clear schedule group. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -The user ID of designated actor. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: RemoveExpanded -Aliases: -Applicable: Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + Required: False Position: Named Default value: None @@ -107,59 +110,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EntityType -The entity types. +### -DateRangeEndDate + +> Applicable: Microsoft Teams + +The end date of removing schedule record. ```yaml -Type: String[] -Parameter Sets: RemoveExpanded +Type: String +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamId -The Teams team ID where you want to remove schedule record. +### -DateRangeStartDate + +> Applicable: Microsoft Teams + +The start date of removing schedule record. ```yaml Type: String -Parameter Sets: RemoveExpanded +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Body -The request body. - -```yaml -Type: IClearScheduleRequest -Parameter Sets: Remove -Aliases: +### -DesignatedActorId -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -Break -Wait for .NET debugger to attach. +The user ID of designated actor. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: RemoveExpanded Aliases: - Required: False Position: Named Default value: None @@ -167,15 +161,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -EntityType -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +> Applicable: Microsoft Teams -Required: False +The entity types. + +```yaml +Type: String[] +Parameter Sets: RemoveExpanded +Aliases: +Required: True Position: Named Default value: None Accept pipeline input: False @@ -272,6 +268,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamId + +> Applicable: Microsoft Teams + +The Teams team ID where you want to remove schedule record. + +```yaml +Type: String +Parameter Sets: RemoveExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TimeZone The Timezone parameter ensures that the shifts are displayed in the correct time zone based on your team's location. diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliance.md similarity index 78% rename from teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliance.md index ec60890b7b..b2f3924be8 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliance.md @@ -1,103 +1,112 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliance -title: Remove-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# Remove-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Remove-CsTeamsSurvivableBranchAppliance [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] - [-Confirm] [] -``` - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The Identity parameter is the unique identifier for the SBA. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliance +schema: 2.0.0 +title: Remove-CsTeamsSurvivableBranchAppliance +--- + +# Remove-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Removes a Survivable Branch Appliance (SBA) from the tenant. + +## SYNTAX + +``` +Remove-CsTeamsSurvivableBranchAppliance [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, +allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during +service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session +Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets +will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The Identity parameter is the unique identifier for the SBA. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md index 6aa49338fb..4e1d5a4752 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,103 +1,108 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliancepolicy -title: Remove-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Remove-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Policy instance name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Remove-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Remove-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Removes a Survivable Branch Appliance (SBA) policy from the tenant. + +## SYNTAX + +``` +Remove-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Policy instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTargetingPolicy.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTargetingPolicy.md index 669d6bc872..51fd546c6c 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTargetingPolicy.md @@ -1,120 +1,121 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy -title: Remove-CsTeamsTargetingPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsTargetingPolicy - -## SYNOPSIS - -The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. - -## SYNTAX - -```powershell -Remove-CsTeamsTargetingPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -Deletes a previously created TeamsTargetingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Remove-CsTeamsMeetingPolicy -Identity StudentTagPolicy -``` - -In the example shown above, the command will delete the student tag policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the teams meeting policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity StudentTagPolicy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) -[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy +schema: 2.0.0 +title: Remove-CsTeamsTargetingPolicy +--- + +# Remove-CsTeamsTargetingPolicy + +## SYNOPSIS + +The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsTargetingPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Deletes a previously created TeamsTargetingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsMeetingPolicy -Identity StudentTagPolicy +``` + +In the example shown above, the command will delete the student tag policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the teams meeting policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity StudentTagPolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTemplatePermissionPolicy.md similarity index 94% rename from teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTemplatePermissionPolicy.md index 28ecb18cd4..e001c992a6 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTemplatePermissionPolicy.md @@ -1,135 +1,135 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy -title: Remove-CsTeamsTemplatePermissionPolicy -author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: -manager: weiliu2 -schema: 2.0.0 ---- - -# Remove-CsTeamsTemplatePermissionPolicy - -## SYNOPSIS -Deletes an instance of TeamsTemplatePermissionPolicy. - -## SYNTAX - -``` -Remove-CsTeamsTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Deletes an instance of TeamsTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. - -## EXAMPLES - -### Example 1 -```powershell -PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar -``` - -Deletes a policy instance with the Identity *Foobar*. - -### Example 2 -```powershell -PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar -``` - -```output -Remove-CsTeamsTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users or groups. Ensure policy is not assigned before removing. Please refer to documentation. CorrelationId: 8622aac5-00c3-4071-b6d0-d070db8f663f -At line:1 char:1 -+ Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar ... -+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsTemplatePermissionPolicy], PolicyRpException - + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsTemplatePermissionPolicyCmdlet -``` - -Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. - -You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Name of the policy instance to be deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) - -[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) - -[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) +--- +author: yishuaihuang4 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy +schema: 2.0.0 +title: Remove-CsTeamsTemplatePermissionPolicy +--- + +# Remove-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Deletes an instance of TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +Remove-CsTeamsTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes an instance of TeamsTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +### Example 1 +```powershell +PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` + +Deletes a policy instance with the Identity *Foobar*. + +### Example 2 +```powershell +PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` + +```output +Remove-CsTeamsTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users or groups. Ensure policy is not assigned before removing. Please refer to documentation. CorrelationId: 8622aac5-00c3-4071-b6d0-d070db8f663f +At line:1 char:1 ++ Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsTemplatePermissionPolicy], PolicyRpException + + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsTemplatePermissionPolicyCmdlet +``` + +Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the policy instance to be deleted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) + +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTranslationRule.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTranslationRule.md index a1cc4fdcae..d9b06f90ad 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule applicable: Microsoft Teams -title: Remove-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule +schema: 2.0.0 +title: Remove-CsTeamsTranslationRule --- # Remove-CsTeamsTranslationRule @@ -42,6 +43,21 @@ This example removes all translation rules with Identifier starting with tst. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Identifier of the rule. This parameter is required. @@ -72,21 +88,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUnassignedNumberTreatment.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUnassignedNumberTreatment.md index 118a64f812..4b50d0e230 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUnassignedNumberTreatment.md @@ -1,74 +1,73 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment -applicable: Microsoft Teams -title: Remove-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Remove-CsTeamsUnassignedNumberTreatment - -## SYNOPSIS -Removes a treatment for how calls to an unassigned number range should be routed. - -## SYNTAX - -``` -Remove-CsTeamsUnassignedNumberTreatment [-Identity] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet removes a treatment for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsTeamsUnassignedNumberTreatment -Identity MainAA -``` -This example removes the treatment MainAA. - -## PARAMETERS - -### -Identity -The Id of the specific treatment to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: ByPropertyName -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.5.1 or later. - -## RELATED LINKS -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) - -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) - -[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) - -[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment +schema: 2.0.0 +title: Remove-CsTeamsUnassignedNumberTreatment +--- + +# Remove-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +Removes a treatment for how calls to an unassigned number range should be routed. + +## SYNTAX + +``` +Remove-CsTeamsUnassignedNumberTreatment [-Identity] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet removes a treatment for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsTeamsUnassignedNumberTreatment -Identity MainAA +``` +This example removes the treatment MainAA. + +## PARAMETERS + +### -Identity +The Id of the specific treatment to remove. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: ByPropertyName +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +## RELATED LINKS +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) + +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) + +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUpdateManagementPolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUpdateManagementPolicy.md index e558236294..1e14de034e 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- +applicable: Microsoft Teams +author: vargasj-ms external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: gnamun Module Name: MicrosoftTeams +ms.author: vargasj online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsupdatemanagementpolicy -applicable: Microsoft Teams -title: Remove-CsTeamsUpdateManagementPolicy schema: 2.0.0 -author: vargasj-ms -ms.author: vargasj -manager: gnamun +title: Remove-CsTeamsUpdateManagementPolicy --- # Remove-CsTeamsUpdateManagementPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVdiPolicy.md similarity index 96% rename from teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVdiPolicy.md index 66afd2e7e6..fcb0b76bd0 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVdiPolicy.md @@ -1,108 +1,109 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvdipolicy -title: Remove-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsVdiPolicy - -## SYNOPSIS -This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. - -## SYNTAX - -```powershell -Remove-CsTeamsVdiPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Deletes a previously created TeamsVdiPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should assign a different policy to them before. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsMeetingPolicy -Identity RestrictedUserPolicy -``` - -In the example shown above, the command will delete the restricted user policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the teams Vdi policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity RestrictedUserPolicy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvdipolicy +schema: 2.0.0 +title: Remove-CsTeamsVdiPolicy +--- + +# Remove-CsTeamsVdiPolicy + +## SYNOPSIS +This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsVdiPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a previously created TeamsVdiPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should assign a different policy to them before. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsMeetingPolicy -Identity RestrictedUserPolicy +``` + +In the example shown above, the command will delete the restricted user policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the teams Vdi policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity RestrictedUserPolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVirtualAppointmentsPolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVirtualAppointmentsPolicy.md index a1a3852ec4..ff3634cdf4 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams +ms.author: erocha online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy -title: Remove-CsTeamsVirtualAppointmentsPolicy schema: 2.0.0 -ms.author: erocha -author: emmanuelrocha001 -manager: sonaggarwal +title: Remove-CsTeamsVirtualAppointmentsPolicy --- # Remove-CsTeamsVirtualAppointmentsPolicy diff --git a/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVoiceApplicationsPolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVoiceApplicationsPolicy.md index 8458e8f402..f13d203141 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy -title: Remove-CsTeamsVoiceApplicationsPolicy schema: 2.0.0 +title: Remove-CsTeamsVoiceApplicationsPolicy --- # Remove-CsTeamsVoiceApplicationsPolicy @@ -37,6 +38,21 @@ In Example 2, all Teams voice applications policies configured at the per-user s ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Unique identifier assigned to the policy when it was created. @@ -68,21 +84,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLoadPolicy.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLoadPolicy.md index c32aafbb08..c924fea852 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLoadPolicy.md @@ -1,125 +1,126 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy -title: Remove-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Remove-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet deletes a Teams Workload Policy instance. - -## SYNTAX - -```powershell -Remove-CsTeamsWorkLoadPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Remove-CsTeamsWorkLoadPolicy -Identity "Test" -``` - -Deletes a Teams Workload policy instance with the identity of "Test". - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Identity of the Teams Workload Policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Microsoft Internal Use Only - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy +schema: 2.0.0 +title: Remove-CsTeamsWorkLoadPolicy +--- + +# Remove-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet deletes a Teams Workload Policy instance. + +## SYNTAX + +```powershell +Remove-CsTeamsWorkLoadPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsWorkLoadPolicy -Identity "Test" +``` + +Deletes a Teams Workload policy instance with the identity of "Test". + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft Internal Use Only + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLocationDetectionPolicy.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLocationDetectionPolicy.md index fd2938fd43..5529df525b 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur Module Name: MicrosoftTeams +ms.author: arkozlov online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy -title: Remove-CsTeamsWorkLocationDetectionPolicy schema: 2.0.0 -ms.author: arkozlov -manager: prashibadkur -author: artemiykozlov +title: Remove-CsTeamsWorkLocationDetectionPolicy --- # Remove-CsTeamsWorkLocationDetectionPolicy diff --git a/teams/teams-ps/teams/Remove-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantDialPlan.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantDialPlan.md index 41c2e91c20..4f50192a38 100644 --- a/teams/teams-ps/teams/Remove-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan applicable: Microsoft Teams -title: Remove-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan +schema: 2.0.0 +title: Remove-CsTenantDialPlan --- # Remove-CsTenantDialPlan @@ -32,7 +33,7 @@ If no tenant dial plan is assigned to an organization, the Global dial plan is u ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsTenantDialPlan -Identity Vt1TenantDialPlan2 ``` @@ -41,46 +42,52 @@ This example removes the Vt1TenantDialPlan2. ## PARAMETERS -### -Identity -The Identity parameter is the unique identifier of the tenant dial plan to remove. +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm parameter prompts you for confirmation before the command is executed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm parameter prompts you for confirmation before the command is executed. +### -Identity + +> Applicable: Microsoft Teams + +The Identity parameter is the unique identifier of the tenant dial plan to remove. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkRegion.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkRegion.md index 5e4b94b289..1d1b60249e 100644 --- a/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion applicable: Microsoft Teams -title: Remove-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion +schema: 2.0.0 +title: Remove-CsTenantNetworkRegion --- # Remove-CsTenantNetworkRegion @@ -36,33 +37,33 @@ The command shown in Example 1 removes 'RedmondRegion'. ## PARAMETERS -### -Identity -Unique identifier for the network region to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network region to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSite.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSite.md index a21acb85be..550e4a5db4 100644 --- a/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite applicable: Microsoft Teams -title: Remove-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite +schema: 2.0.0 +title: Remove-CsTenantNetworkSite --- # Remove-CsTenantNetworkSite @@ -37,33 +38,33 @@ The command shown in Example 1 removes 'site1'. ## PARAMETERS -### -Identity -Unique identifier for the network site to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network site to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSubnet.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSubnet.md index 2e8c9def13..1e9724fd63 100644 --- a/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet applicable: Microsoft Teams -title: Remove-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet +schema: 2.0.0 +title: Remove-CsTenantNetworkSubnet --- # Remove-CsTenantNetworkSubnet @@ -37,33 +38,33 @@ The command shown in Example 1 removes '192.168.0.1'. ## PARAMETERS -### -Identity -Unique identifier for the network subnet to be removed. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network subnet to be removed. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantTrustedIPAddress.md similarity index 98% rename from teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsTenantTrustedIPAddress.md index 36eb4e2803..400a07e540 100644 --- a/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsTenantTrustedIPAddress.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenanttrustedipaddress applicable: Microsoft Teams -title: Remove-CsTenantTrustedIPAddress -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenanttrustedipaddress +schema: 2.0.0 +title: Remove-CsTenantTrustedIPAddress --- # Remove-CsTenantTrustedIPAddress diff --git a/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md b/teams/teams-ps/MicrosoftTeams/Remove-CsUserCallingDelegate.md similarity index 95% rename from teams/teams-ps/teams/Remove-CsUserCallingDelegate.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsUserCallingDelegate.md index 56d6d9bce2..cc54ef90cf 100644 --- a/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsUserCallingDelegate.md @@ -1,91 +1,90 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate -applicable: Microsoft Teams -title: Remove-CsUserCallingDelegate -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Remove-CsUserCallingDelegate - -## SYNOPSIS -This cmdlet will remove a delegate for calling in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -```powershell -Remove-CsUserCallingDelegate -Identity -Delegate [] -``` - -## DESCRIPTION -This cmdlet will remove a delegate for the specified user. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -``` -This example shows removing the delegate user2@contoso.com. - -## PARAMETERS - -### -Delegate -The Identity of the delegate to remove. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to remove a delegate for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, -and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -The specified user need to have the Microsoft Phone System license assigned. - -You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. - -## RELATED LINKS -[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate +schema: 2.0.0 +title: Remove-CsUserCallingDelegate +--- + +# Remove-CsUserCallingDelegate + +## SYNOPSIS +This cmdlet will remove a delegate for calling in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +```powershell +Remove-CsUserCallingDelegate -Identity -Delegate [] +``` + +## DESCRIPTION +This cmdlet will remove a delegate for the specified user. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com +``` +This example shows removing the delegate user2@contoso.com. + +## PARAMETERS + +### -Delegate +The Identity of the delegate to remove. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to remove a delegate for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, +and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +The specified user need to have the Microsoft Phone System license assigned. + +You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. + +## RELATED LINKS +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md b/teams/teams-ps/MicrosoftTeams/Remove-CsUserLicenseGracePeriod.md similarity index 99% rename from teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsUserLicenseGracePeriod.md index 8ba1f83cc3..e824b25558 100644 --- a/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsUserLicenseGracePeriod.md @@ -1,13 +1,14 @@ --- +author: serdarsoysal +description: This cmdlet expedites the delicensing operation for an account's assigned plans by removing the grace period, permanently deleting the assigned plans. external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars +ms.date: 02/01/2024 online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserlicensegraceperiod -title: Remove-CsUserLicenseGracePeriod -description: This cmdlet expedites the delicensing operation for an account's assigned plans by removing the grace period, permanently deleting the assigned plans. schema: 2.0.0 -ms.date: 02/01/2024 -author: serdarsoysal -ms.author: serdars +title: Remove-CsUserLicenseGracePeriod --- # Remove-CsUserLicenseGracePeriod @@ -63,19 +64,35 @@ In Example 2, the capability specified refers to plans assigned to the user(s) u ## PARAMETERS -### -Identity +### -Action -Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan. +Used to specify which action should be taken. ```yaml Type: String Parameter Sets: (All) Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body + +Specifies the body of the request. + +```yaml +Type: IUserDelicensingAccelerationPatch +Parameter Sets: (All) +Aliases: + Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName,ByValue) +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -111,19 +128,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Identity -Returns the results of the command. By default, this cmdlet does not generate any output. +Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName,ByValue) Accept wildcard characters: False ``` @@ -143,12 +160,12 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Action +### -PassThru -Used to specify which action should be taken. +Returns the results of the command. By default, this cmdlet does not generate any output. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -159,22 +176,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Body - -Specifies the body of the request. - -```yaml -Type: IUserDelicensingAccelerationPatch -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/Remove-CsVideoInteropServiceProvider.md similarity index 84% rename from teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/Remove-CsVideoInteropServiceProvider.md index 9344dcff1d..c338014ecc 100644 --- a/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-CsVideoInteropServiceProvider.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/remove-csvideointeropserviceprovider applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Remove-CsVideoInteropServiceProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/remove-csvideointeropserviceprovider +schema: 2.0.0 +title: Remove-CsVideoInteropServiceProvider --- # Remove-CsVideoInteropServiceProvider ## SYNOPSIS -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. +Use the Remove-CsVideoInteropServiceProvider to remove all provider information about a provider that your organization no longer uses. ## SYNTAX @@ -30,7 +31,7 @@ Remove-CsVideoInteropServiceProvider [[-Identity] ] ## DESCRIPTION Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. -Use the Remove-CsVideoInteropServiceProvider to remove all provider information about a provider that your organization no longer uses. The only input is Identity - the provider you wish to remove. +The only input is Identity - the provider you wish to remove. ## EXAMPLES diff --git a/teams/teams-ps/teams/Remove-SharedWithTeam.md b/teams/teams-ps/MicrosoftTeams/Remove-SharedWithTeam.md similarity index 96% rename from teams/teams-ps/teams/Remove-SharedWithTeam.md rename to teams/teams-ps/MicrosoftTeams/Remove-SharedWithTeam.md index e143bc6c3c..1b8789c92f 100644 --- a/teams/teams-ps/teams/Remove-SharedWithTeam.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-SharedWithTeam.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-sharedwithteam -title: Remove-SharedWithTeam -schema: 2.0.0 -author: serdarsoysal ms.author: serdars ms.reviewer: dedaniel, robharad +online version: https://learn.microsoft.com/powershell/module/teams/remove-sharedwithteam +schema: 2.0.0 +title: Remove-SharedWithTeam --- # Remove-SharedWithTeam @@ -34,8 +35,8 @@ Unshares a channel with a team. ## PARAMETERS -### -HostTeamId -Team ID of the host team (Group ID). +### -ChannelId +Thread ID of the shared channel. ```yaml Type: String @@ -49,8 +50,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ChannelId -Thread ID of the shared channel. +### -HostTeamId +Team ID of the host team (Group ID). ```yaml Type: String @@ -84,7 +85,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### HostTeamId, ChannelId, SharedWithTeamId +### HostTeamId + +### ChannelId + +### SharedWithTeamId ## OUTPUTS diff --git a/teams/teams-ps/teams/Remove-Team.md b/teams/teams-ps/MicrosoftTeams/Remove-Team.md similarity index 99% rename from teams/teams-ps/teams/Remove-Team.md rename to teams/teams-ps/MicrosoftTeams/Remove-Team.md index b379c99308..52ac99d0f0 100644 --- a/teams/teams-ps/teams/Remove-Team.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-Team.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/remove-team -title: Remove-Team schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Remove-Team --- # Remove-Team diff --git a/teams/teams-ps/teams/Remove-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannel.md similarity index 99% rename from teams/teams-ps/teams/Remove-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamChannel.md index 9ab0da2703..e7d7cc4e79 100644 --- a/teams/teams-ps/teams/Remove-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannel.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/remove-teamchannel -title: Remove-TeamChannel schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Remove-TeamChannel --- # Remove-TeamChannel @@ -14,11 +14,6 @@ ms.reviewer: ## SYNOPSIS Delete a channel. -This will not delete content in associated tabs. - -Note: The channel will be "soft deleted", meaning the contents are not permanently deleted for a time. -So a subsequent call to Add-TeamChannel using the same channel name will fail if enough time has not passed. - ## SYNTAX ``` @@ -26,6 +21,10 @@ Remove-TeamChannel -GroupId -DisplayName [] ``` ## DESCRIPTION +This will not delete content in associated tabs. + +Note: The channel will be "soft deleted", meaning the contents are not permanently deleted for a time. +So a subsequent call to Add-TeamChannel using the same channel name will fail if enough time has not passed. > [!IMPORTANT] > Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here `https://www.poshtestgallery.com/packages/MicrosoftTeams`. @@ -39,8 +38,8 @@ Remove-TeamChannel -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "T ## PARAMETERS -### -GroupId -GroupId of the team +### -DisplayName +Channel name to be deleted ```yaml Type: String @@ -54,8 +53,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Channel name to be deleted +### -GroupId +GroupId of the team ```yaml Type: String diff --git a/teams/teams-ps/teams/Remove-TeamChannelUser.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannelUser.md similarity index 83% rename from teams/teams-ps/teams/Remove-TeamChannelUser.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamChannelUser.md index 5593e0c440..b3541fbb31 100644 --- a/teams/teams-ps/teams/Remove-TeamChannelUser.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamChannelUser.md @@ -1,21 +1,16 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/remove-teamchanneluser -title: Remove-TeamChannelUser schema: 2.0.0 +title: Remove-TeamChannelUser --- # Remove-TeamChannelUser ## SYNOPSIS -> [!Note] -> The command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. - -To turn an existing Owner into a Member, specify role parameter as Owner. - -> [!Note] -> Last owner cannot be removed from the private channel. +Removes a user from a channel in Microsoft Teams. ## SYNTAX @@ -26,20 +21,28 @@ Remove-TeamChannelUser -GroupId -DisplayName -User [- ## DESCRIPTION -> [!Note] -> This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). +> [!NOTE] +> This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](/microsoftteams/teams-powershell-release-notes). + +The command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. + +To turn an existing Owner into a Member, specify role parameter as Owner. + +> [!NOTE] +> Last owner cannot be removed from the private channel. ## EXAMPLES ### Example 1 + ``` Remove-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User dmx@example.com ``` ## PARAMETERS -### -GroupId -GroupId of the team +### -DisplayName +Display name of the private channel ```yaml Type: String @@ -53,8 +56,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisplayName -Display name of the private channel +### -GroupId +GroupId of the team ```yaml Type: String @@ -68,31 +71,31 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -User -User's email address (e.g. -johndoe@example.com) +### -Role +Use this to demote a user from owner to member of the team ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Role -Use this to demote a user from owner to member of the team +### -User +User's email address (e.g. +johndoe@example.com) ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) diff --git a/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamTargetingHierarchy.md similarity index 99% rename from teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamTargetingHierarchy.md index 01e2e675e0..aa3b75dcfd 100644 --- a/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamTargetingHierarchy.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams -title: Remove-TeamTargetingHierarchy schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Remove-TeamTargetingHierarchy --- # Remove-TeamTargetingHierarchy diff --git a/teams/teams-ps/teams/Remove-TeamUser.md b/teams/teams-ps/MicrosoftTeams/Remove-TeamUser.md similarity index 99% rename from teams/teams-ps/teams/Remove-TeamUser.md rename to teams/teams-ps/MicrosoftTeams/Remove-TeamUser.md index 489e626447..eb9fe41199 100644 --- a/teams/teams-ps/teams/Remove-TeamUser.md +++ b/teams/teams-ps/MicrosoftTeams/Remove-TeamUser.md @@ -1,25 +1,19 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/remove-teamuser -title: Remove-TeamUser schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Remove-TeamUser --- # Remove-TeamUser ## SYNOPSIS - Remove an owner or member from a team, and from the unified group which backs the team. -Note: The command will return immediately, but the Teams application will not reflect the update immediately. -The Teams application may need to be open for up to an hour before changes are reflected. - -Note: The last owner cannot be removed from the team. - ## SYNTAX ``` @@ -27,6 +21,11 @@ Remove-TeamUser -GroupId -User [-Role ] [ Applicable: Teams + +Prompts you for confirmation before executing the command. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowRemoveParticipantAppIds +### -Force -A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). +> Applicable: Teams + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -103,46 +106,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +Unique identifier of the application meeting configuration settings to be returned. +Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Set-CsApplicationMeetingConfiguration cmdlet. +However, you can use the following syntax to retrieve the global settings: -Identity global. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Teams -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Teams + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Teams +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Set-CsAutoAttendant.md similarity index 96% rename from teams/teams-ps/teams/Set-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Set-CsAutoAttendant.md index f1241561ad..afb1a705ec 100644 --- a/teams/teams-ps/teams/Set-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csautoattendant applicable: Microsoft Teams -title: Set-CsAutoAttendant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csautoattendant +schema: 2.0.0 +title: Set-CsAutoAttendant --- # Set-CsAutoAttendant @@ -26,7 +28,7 @@ The Set-CsAutoAttendant cmdlet lets you modify the properties of an auto attenda ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" @@ -48,7 +50,7 @@ Set-CsAutoAttendant -Instance $autoAttendant This example adds a Christmas holiday to an AA that has an Identity of fa9081d6-b4f3-5c96-baec-0b00077709e5. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" @@ -78,7 +80,7 @@ Set-CsAutoAttendant -Instance $autoAttendant This example modifies the Christmas holiday greeting for the AA that has an Identity of fa9081d6-b4f3-5c96-baec-0b00077709e5. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell $autoAttendant = Get-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" $autoAttendant.CallHandlingAssociations diff --git a/teams/teams-ps/teams/Set-CsCallQueue.md b/teams/teams-ps/MicrosoftTeams/Set-CsCallQueue.md similarity index 99% rename from teams/teams-ps/teams/Set-CsCallQueue.md rename to teams/teams-ps/MicrosoftTeams/Set-CsCallQueue.md index 8f93fc3973..0a3f723f84 100644 --- a/teams/teams-ps/teams/Set-CsCallQueue.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsCallQueue.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cscallqueue applicable: Microsoft Teams -title: Set-CsCallQueue -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-cscallqueue +schema: 2.0.0 +title: Set-CsCallQueue --- # Set-CsCallQueue @@ -68,14 +69,14 @@ Note that this cmdlet is in the Skype for Business Online PowerShell module and ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -UseDefaultMusicOnHold $true ``` This example updates the Call Queue with identity e7e00636-47da-449c-a36b-1b3d6ee04440 by making it use the default music on hold. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -MusicOnHoldAudioFileId $audioFile.Id ``` @@ -84,22 +85,6 @@ This example updates the Call Queue with new distribution lists and references a ## PARAMETERS -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AgentAlertTime The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. @@ -132,8 +117,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DistributionLists -The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. +### -AuthorizedUsers +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml Type: List @@ -148,8 +133,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MusicOnHoldAudioFileId -The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. +### -CallbackEmailNotificationTarget + +The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml Type: Guid @@ -164,11 +150,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the Call Queue. +### -CallbackOfferAudioFilePromptResourceId + +The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -180,11 +167,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OboResourceAccountIds -The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. +### -CallbackOfferTextToSpeechPrompt + +The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml -Type: List +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -196,32 +184,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowAction -The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. - -PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail +### -CallbackRequestDtmf -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: -Required: False -Position: Named -Default value: DisconnectWithBusy -Accept pipeline input: False -Accept wildcard characters: False -``` +- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. +- ToneStar - Corresponds to DTMF tone *. +- TonePound - Corresponds to DTMF tone #. -### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. +This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -230,26 +206,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -If the OverflowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. +### -CallToAgentRatioThresholdBeforeOfferingCallback -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This conditon applies to calls arriving at the call queue. Minimum value of one (1). Set to null ($null) to disable this condition. -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -258,91 +224,86 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowThreshold -The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. +### -ChannelId +Id of the channel to connect a call queue to. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: 50 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RoutingMethod -The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called. - -PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle +### -ChannelUserObjectId +The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team that the channel belongs to. ```yaml -Type: Object +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: Attendant +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutAction -The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. +### -ComplianceRecordingForCallQueueTemplateId +_Voice applications private preview customers only._ -PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. ```yaml -Type: Object +Type: List Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionTarget -The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. +### -ConferenceMode +The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: + +- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. + +- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. +### -CustomAudioFileAnnouncementForCR +_Voice applications private preview customers only._ -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -354,105 +315,92 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutThreshold -The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. -The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. +### -CustomAudioFileAnnouncementForCRFailure +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: 1200 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentApplyTo -The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. - -PARAMVALUE: AllCalls | NewCalls +### -DistributionLists +The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. ```yaml -Type: Object +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentAction -The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. - -PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail +### -EnableNoAgentSharedVoicemailSystemPromptSuppression +The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: Disconnect +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentActionTarget -The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this field is optional. +### -EnableNoAgentSharedVoicemailTranscription +The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentActionCallPriority -_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ - -If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. - -PARAMVALUE: 1 | 2 | 3 | 4 | 5 -- 1 = Very High -- 2 = High -- 3 = Normal / Default -- 4 = Low -- 5 = Very Low - -> [!IMPORTANT] -> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. +### -EnableOverflowSharedVoicemailSystemPromptSuppression +The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: Int16 +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDefaultMusicOnHold -The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. +### -EnableOverflowSharedVoicemailTranscription +The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml Type: Boolean @@ -462,29 +410,29 @@ applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeMusicAudioFileId -The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. +### -EnableTimeoutSharedVoicemailSystemPromptSuppression +The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PresenceBasedRouting -The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. +### -EnableTimeoutSharedVoicemailTranscription +The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. ```yaml Type: Boolean @@ -499,31 +447,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConferenceMode -The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: - -- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. +### -HideAuthorizedUsers +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. +This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). ```yaml -Type: Boolean +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Users -The User parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). +### -Identity +PARAMVALUE: Guid ```yaml -Type: List +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -535,14 +481,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for Microsoft internal use only. +### -IsCallbackEnabled + +The IsCallbackEnabled parameter is used to turn on/off callback. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -585,8 +531,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectAudioFilePrompt -The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. +### -MusicOnHoldAudioFileId +The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. ```yaml Type: Guid @@ -601,8 +547,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowDisconnectTextToSpeechPrompt -The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. +### -Name +The Name parameter specifies a unique name for the Call Queue. ```yaml Type: String @@ -617,31 +563,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentAction +The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. -The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. +PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NoAgentActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ -The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. +If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -653,11 +609,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppAudioFilePrompt -The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentActionTarget +The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this field is optional. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -669,24 +625,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoiceAppTextToSpeechPrompt -The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. +### -NoAgentApplyTo +The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. + +PARAMVALUE: AllCalls | NewCalls ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberAudioFilePrompt -The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -NoAgentDisconnectAudioFilePrompt +The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. ```yaml Type: Guid @@ -701,8 +659,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectPhoneNumberTextToSpeechPrompt -The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. +### -NoAgentDisconnectTextToSpeechPrompt +The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. ```yaml Type: String @@ -717,10 +675,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailAudioFilePrompt +### -NoAgentRedirectPersonAudioFilePrompt _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. +The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. ```yaml Type: Guid @@ -735,10 +693,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowRedirectVoicemailTextToSpeechPrompt +### -NoAgentRedirectPersonTextToSpeechPrompt _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. +The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. ```yaml Type: String @@ -753,11 +711,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailTextToSpeechPrompt -The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. +### -NoAgentRedirectPhoneNumberAudioFilePrompt +The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -769,11 +727,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowSharedVoicemailAudioFilePrompt -The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. +### -NoAgentRedirectPhoneNumberTextToSpeechPrompt +The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -785,40 +743,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailTranscription -The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -NoAgentRedirectVoiceAppAudioFilePrompt +The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOverflowSharedVoicemailSystemPromptSuppression -The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -NoAgentRedirectVoiceAppTextToSpeechPrompt +The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectAudioFilePrompt -The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. +### -NoAgentRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml Type: Guid @@ -833,8 +793,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutDisconnectTextToSpeechPrompt -The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. +### -NoAgentRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. ```yaml Type: String @@ -849,8 +811,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonAudioFilePrompt -The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. +### -NoAgentSharedVoicemailAudioFilePrompt +The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid @@ -865,10 +827,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. +### -NoAgentSharedVoicemailTextToSpeechPrompt +The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. ```yaml Type: String @@ -883,16 +843,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -NumberOfCallsInQueueBeforeOfferingCallback -The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. +The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -901,11 +861,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoiceAppTextToSpeechPrompt -The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. +### -OboResourceAccountIds +The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -917,27 +877,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberAudioFilePrompt -The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowAction +The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. + +PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: DisconnectWithBusy Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectPhoneNumberTextToSpeechPrompt -The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. +### -OverflowActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the OverflowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -949,13 +923,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. +### -OverflowActionTarget +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -967,13 +939,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. +### -OverflowDisconnectAudioFilePrompt +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -985,8 +955,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailTextToSpeechPrompt -The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. +### -OverflowDisconnectTextToSpeechPrompt +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. ```yaml Type: String @@ -1001,8 +971,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutSharedVoicemailAudioFilePrompt -The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. +### -OverflowRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml Type: Guid @@ -1017,40 +989,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailTranscription -The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. +### -OverflowRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTimeoutSharedVoicemailSystemPromptSuppression -The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. +### -OverflowRedirectPhoneNumberAudioFilePrompt +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectTextToSpeechPrompt -The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. +### -OverflowRedirectPhoneNumberTextToSpeechPrompt +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. ```yaml Type: String @@ -1065,8 +1039,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentDisconnectAudioFilePrompt -The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. +### -OverflowRedirectVoiceAppAudioFilePrompt +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: Guid @@ -1081,10 +1055,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. +### -OverflowRedirectVoiceAppTextToSpeechPrompt +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. ```yaml Type: String @@ -1099,10 +1071,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPersonAudioFilePrompt +### -OverflowRedirectVoicemailAudioFilePrompt _Saving a call queue configuration through Teams admin center will *remove* this setting._ -The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: Guid @@ -1117,8 +1089,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppTextToSpeechPrompt -The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. +### -OverflowRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. ```yaml Type: String @@ -1133,8 +1107,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoiceAppAudioFilePrompt -The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. +### -OverflowSharedVoicemailAudioFilePrompt +The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. ```yaml Type: Guid @@ -1149,8 +1123,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberTextToSpeechPrompt -The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -OverflowSharedVoicemailTextToSpeechPrompt +The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. ```yaml Type: String @@ -1165,66 +1139,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectPhoneNumberAudioFilePrompt -The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. +### -OverflowThreshold +The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: 50 Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailTextToSpeechPrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. +### -PresenceBasedRouting +The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentRedirectVoicemailAudioFilePrompt -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -RoutingMethod +The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called. -The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. +PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle ```yaml -Type: Guid +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Attendant Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailTextToSpeechPrompt -The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. +### -ServiceLevelThresholdResponseTimeInSecond + +The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. + +A value of `$null` indicates that a service level percentage will not be calculated for this call queue. ```yaml -Type: String +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1233,14 +1207,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentSharedVoicemailAudioFilePrompt -The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. +### -SharedCallQueueHistoryTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1249,56 +1226,64 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailTranscription -The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -ShiftsSchedulingGroupId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Scheduling Group to connect a call queue to. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNoAgentSharedVoicemailSystemPromptSuppression -The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. +### -ShiftsTeamId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Team containing the Scheduling Group to connect a call queue to. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelId -Id of the channel to connect a call queue to. +### -ShouldOverwriteCallableChannelProperty + +A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelUserObjectId -The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team that the channel belongs to. +### -Tenant +This parameter is reserved for Microsoft internal use only. ```yaml Type: Guid @@ -1313,12 +1298,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShiftsTeamId +### -TextAnnouncementForCR _Voice applications private preview customers only._ _Saving a call queue configuration through Teams admin center will *remove* this setting._ -Id of the Team containing the Scheduling Group to connect a call queue to. +The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. ```yaml Type: String @@ -1333,12 +1318,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShiftsSchedulingGroupId +### -TextAnnouncementForCRFailure _Voice applications private preview customers only._ _Saving a call queue configuration through Teams admin center will *remove* this setting._ -Id of the Scheduling Group to connect a call queue to. +The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. ```yaml Type: String @@ -1353,29 +1338,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthorizedUsers -This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +### -TimeoutAction +The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. + +PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail ```yaml -Type: List +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Disconnect Accept pipeline input: False Accept wildcard characters: False ``` -### -HideAuthorizedUsers -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +### -TimeoutActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ -This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). +If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. ```yaml -Type: List +Type: Int16 Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -1387,13 +1384,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WelcomeTextToSpeechPrompt -This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. +### -TimeoutActionTarget +The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. ```yaml Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1402,14 +1400,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsCallbackEnabled - -The IsCallbackEnabled parameter is used to turn on/off callback. +### -TimeoutDisconnectAudioFilePrompt +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1418,20 +1416,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackRequestDtmf - -The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: - -- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. -- ToneStar - Corresponds to DTMF tone *. -- TonePound - Corresponds to DTMF tone #. - -This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. +### -TimeoutDisconnectTextToSpeechPrompt +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. ```yaml Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1440,16 +1432,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WaitTimeBeforeOfferingCallbackInSecond - -The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. - -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +### -TimeoutRedirectPersonAudioFilePrompt +The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. ```yaml -Type: Int16 +Type: Guid Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1458,16 +1448,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberOfCallsInQueueBeforeOfferingCallback - -The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. +### -TimeoutRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1476,16 +1466,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallToAgentRatioThresholdBeforeOfferingCallback +### -TimeoutRedirectPhoneNumberAudioFilePrompt +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. -The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This conditon applies to calls arriving at the call queue. Minimum value of one (1). Set to null ($null) to disable this condition. +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams -At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt +The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1494,9 +1498,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferAudioFilePromptResourceId +### -TimeoutRedirectVoiceAppAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. +The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. ```yaml Type: Guid @@ -1511,9 +1516,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackOfferTextToSpeechPrompt - -The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. +### -TimeoutRedirectVoiceAppTextToSpeechPrompt +The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. ```yaml Type: String @@ -1528,9 +1532,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallbackEmailNotificationTarget +### -TimeoutRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. +The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. ```yaml Type: Guid @@ -1545,16 +1550,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceLevelThresholdResponseTimeInSecond - -The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. +### -TimeoutRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ -A value of `$null` indicates that a service level percentage will not be calculated for this call queue. +The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. ```yaml -Type: Int16 +Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1563,17 +1568,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingForCallQueueTemplateId -_Voice applications private preview customers only._ - -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. +### -TimeoutSharedVoicemailAudioFilePrompt +The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. ```yaml -Type: List +Type: Guid Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1582,12 +1584,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextAnnouncementForCR -_Voice applications private preview customers only._ - -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. +### -TimeoutSharedVoicemailTextToSpeechPrompt +The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. ```yaml Type: String @@ -1602,15 +1600,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomAudioFileAnnouncementForCR -_Voice applications private preview customers only._ +### -TimeoutThreshold +The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. +The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams -The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. +Required: False +Position: Named +Default value: 1200 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDefaultMusicOnHold +The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -1622,15 +1633,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TextAnnouncementForCRFailure -_Voice applications private preview customers only._ - -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. +### -Users +The User parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). ```yaml -Type: String +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -1642,18 +1649,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomAudioFileAnnouncementForCRFailure -_Voice applications private preview customers only._ +### -WaitTimeBeforeOfferingCallbackInSecond -_Saving a call queue configuration through Teams admin center will *remove* this setting._ +The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. -The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. ```yaml -Type: Guid +Type: Int16 Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -1662,17 +1667,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharedCallQueueHistoryTemplateId -_Voice applications private preview customers only._ - -_Saving a call queue configuration through Teams admin center will *remove* this setting._ - -The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. +### -WelcomeMusicAudioFileId +The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1681,18 +1683,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShouldOverwriteCallableChannelProperty - -A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. +### -WelcomeTextToSpeechPrompt +This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsCallingLineIdentity.md b/teams/teams-ps/MicrosoftTeams/Set-CsCallingLineIdentity.md similarity index 99% rename from teams/teams-ps/teams/Set-CsCallingLineIdentity.md rename to teams/teams-ps/MicrosoftTeams/Set-CsCallingLineIdentity.md index 16e76a4a04..5968d9eec4 100644 --- a/teams/teams-ps/teams/Set-CsCallingLineIdentity.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsCallingLineIdentity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity applicable: Microsoft Teams -title: Set-CsCallingLineIdentity -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity +schema: 2.0.0 +title: Set-CsCallingLineIdentity --- # Set-CsCallingLineIdentity @@ -116,6 +117,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description The Description parameter briefly describes the Caller ID policy. @@ -201,22 +218,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/MicrosoftTeams/Set-CsComplianceRecordingForCallQueueTemplate.md similarity index 92% rename from teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md rename to teams/teams-ps/MicrosoftTeams/Set-CsComplianceRecordingForCallQueueTemplate.md index 2ee33ba19c..071ccbbbdc 100644 --- a/teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsComplianceRecordingForCallQueueTemplate.md @@ -1,17 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsComplianceRecordingForCallQueueTemplate applicable: Microsoft Teams -title: Set-CsComplianceRecordingForCallQueueTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +title: Set-CsComplianceRecordingForCallQueueTemplate --- # Set-CsComplianceRecordingForCallQueueTemplate +## SYNOPSIS +Use the Set-CsComplianceRecordingForCallQueueTemplate cmdlet to make changes to an existing Compliance Recording for Call Queues template. + ## SYNTAX ```powershell @@ -26,7 +30,7 @@ Use the Set-CsComplianceRecordingForCallQueueTemplate cmdlet to make changes to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $template = CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 $template.BotId = 14732826-8206-42e3-b51e-6693e2abb698 diff --git a/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsExternalAccessPolicy.md similarity index 87% rename from teams/teams-ps/teams/Set-CsExternalAccessPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsExternalAccessPolicy.md index afa75f770a..e96bead50d 100644 --- a/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsExternalAccessPolicy.md @@ -1,19 +1,18 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.reviewer: rogupta online version: https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy -applicable: Microsoft Teams -title: Set-CsExternalAccessPolicy schema: 2.0.0 -ms.reviewer: rogupta +title: Set-CsExternalAccessPolicy --- # Set-CsExternalAccessPolicy ## SYNOPSIS Enables you to modify the properties of an existing external access policy. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. - -This cmdlet was introduced in Lync Server 2010. ## SYNTAX @@ -66,6 +65,8 @@ Set-CsExternalAccessPolicy [-Instance ] ``` ## DESCRIPTION +This cmdlet was introduced in Lync Server 2010. + When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with people who have SIP accounts in your Active Directory Domain Services. In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. @@ -94,7 +95,7 @@ If you would like to grant this capability to all of your users you can call the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederationAccess $True ``` @@ -102,7 +103,7 @@ Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederati The command shown in Example 1 modifies the per-user external access policy that has the Identity RedmondExternalAccessPolicy. In this example, the command changes the value of the EnableFederationAccess property to True. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsExternalAccessPolicy | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` @@ -111,7 +112,7 @@ In Example 2, federation access is enabled for all the external access policies To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet without any parameters; this returns a collection of all the external policies currently configured for use. That collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which changes the value of the EnableFederationAccess property for each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsExternalAccessPolicy -Filter tag:* | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` @@ -121,7 +122,7 @@ To carry out this task, the first thing the command does is use the `Get-CsExter (The filter value "tag:*" limits returned data to policies that have an Identity that begins with the string value "tag:". Any policy with an Identity that begins with "tag:" has been configured at the per-user scope.) The filtered collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which modifies the EnableFederationAccess property for each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $false New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAccess $true @@ -129,7 +130,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAc In this example, the Global policy is updated to disallow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation enabled and which can be assigned to selected users for which Team-ACS federation will be allowed. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false @@ -137,7 +138,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederatio In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. -### -------------------------- Example 6 ------------------------ +### Example 6 ``` New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWithExternalOrgs "AllowSpecificExternalDomains" -AllowedExternalDomains @("example1.com", "example2.com") Set-CsTenantFederationConfiguration -CustomizeFederation $true @@ -146,46 +147,10 @@ In this example, we create an ExternalAccessPolicy named "GranularFederationExam ## PARAMETERS -### -Identity -Unique identifier for the external access policy to be modified. -External access policies can be configured at the global, site, or per-user scopes. -To modify the global policy, use this syntax: `-Identity global`. -To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. -To modify a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. -If this parameter is not specified then the global policy will be modified. - -Note that wildcards are not allowed when specifying an Identity. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -AllowedExternalDomains -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowedExternalDomains > [!NOTE] > Please note that this parameter is in Private Preview. @@ -194,7 +159,6 @@ Specifies the external domains allowed to communicate with users assigned to thi Type: List Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -204,6 +168,9 @@ Accept wildcard characters: False ``` ### -BlockedExternalDomains + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + > [!NOTE] > Please note that this parameter is in Private Preview. @@ -212,7 +179,6 @@ Specifies the external domains blocked from communicating with users assigned to Type: List Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -222,6 +188,9 @@ Accept wildcard characters: False ``` ### -CommunicationWithExternalOrgs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + > [!NOTE] > Please note that this parameter is in Private Preview. @@ -238,7 +207,6 @@ The setting is only applicable when `EnableFederationAccess` is set to true. Thi Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -248,13 +216,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -264,6 +234,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. @@ -271,7 +244,6 @@ For example, the Description might include information about the users the polic Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -281,6 +253,9 @@ Accept wildcard characters: False ``` ### -EnableAcsFederationAccess + +> Applicable: Microsoft Teams + Indicates whether Teams meeting organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. @@ -293,7 +268,6 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -302,6 +276,9 @@ Accept wildcard characters: False ``` ### -EnableFederationAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization. Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. @@ -310,7 +287,6 @@ The default value is True. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -320,6 +296,9 @@ Accept wildcard characters: False ``` ### -EnableOutsideAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. The default value is False. @@ -327,7 +306,6 @@ The default value is False. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -337,6 +315,9 @@ Accept wildcard characters: False ``` ### -EnablePublicCloudAudioVideoAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. When set to False, audio and video options in Skype for Business will be disabled any time a user is communicating with a public Internet connectivity contact. The default value is False. @@ -345,7 +326,6 @@ The default value is False. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -355,6 +335,9 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + (Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. @@ -366,7 +349,6 @@ The default value is True. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -376,6 +358,9 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerInbound + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + (Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user. To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. @@ -387,7 +372,6 @@ The default value is True. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -413,6 +397,9 @@ Accept wildcard characters: False ``` ### -EnableXmppAccess + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. The default value is False. @@ -420,7 +407,6 @@ The default value is False. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -432,12 +418,12 @@ Accept wildcard characters: False ### -FederatedBilateralChats This setting enables bi-lateral chats for the users included in the messaging policy. -Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. - -Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. - +Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. + +Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. + Users with bilateral policy applied are also removed from existing external group chats with more than two organizations. - + This policy doesn't apply to meetings, meeting chats, or channels. ```yaml @@ -453,13 +439,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -468,6 +456,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the external access policy to be modified. +External access policies can be configured at the global, site, or per-user scopes. +To modify the global policy, use this syntax: `-Identity global`. +To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. +To modify a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. +If this parameter is not specified then the global policy will be modified. + +Note that wildcards are not allowed when specifying an Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -RestrictTeamsConsumerAccessToExternalUserProfiles Defines if a user is restriced to collaboration with Teams Consumer (TFL) user only in Extended Directory Possible Values: True, False @@ -507,13 +538,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Set-CsInboundBlockedNumberPattern.md similarity index 98% rename from teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Set-CsInboundBlockedNumberPattern.md index 010cb41526..2473bbe946 100644 --- a/teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsInboundBlockedNumberPattern.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern applicable: Microsoft Teams -title: Set-CsInboundBlockedNumberPattern author: serdarsoysal -ms.author: serdars -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: bulenteg +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern schema: 2.0.0 +title: Set-CsInboundBlockedNumberPattern --- # Set-CsInboundBlockedNumberPattern @@ -37,6 +38,21 @@ This example modifies a blocked number pattern to block inbound calls from +1123 ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description A friendly description for the blocked number pattern to be modified. @@ -113,21 +129,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Set-CsInboundExemptNumberPattern.md similarity index 98% rename from teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Set-CsInboundExemptNumberPattern.md index 592cc10d0f..de4163ec59 100644 --- a/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsInboundExemptNumberPattern.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern applicable: Microsoft Teams -title: Set-CsInboundExemptNumberPattern -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern +schema: 2.0.0 +title: Set-CsInboundExemptNumberPattern --- # Set-CsInboundExemptNumberPattern @@ -48,6 +48,22 @@ Disables the exempt number pattern from usage in call blocking ## PARAMETERS +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Sets the description of the number pattern. @@ -126,22 +142,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineApplicationInstance.md similarity index 94% rename from teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineApplicationInstance.md index 4e64fee3fa..5881896025 100644 --- a/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineApplicationInstance.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance applicable: Microsoft Teams -title: Set-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance +schema: 2.0.0 +title: Set-CsOnlineApplicationInstance --- # Set-CsOnlineApplicationInstance @@ -15,8 +16,6 @@ ms.reviewer: ## SYNOPSIS Updates an application instance in Microsoft Entra ID. -**Note**: The use of this cmdlet for assigning phone numbers in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. - ## SYNTAX ``` @@ -26,9 +25,11 @@ Set-CsOnlineApplicationInstance [-Identity] [[-OnpremPhoneNumber] Applicable: Microsoft Teams + The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -87,29 +71,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcsResourceId -The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Microsoft Teams + The display name. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +108,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -134,31 +125,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Identity + +> Applicable: Microsoft Teams + +The URI or ID of the application instance to update. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnpremPhoneNumber + +> Applicable: Microsoft Teams + +**Note**: Using this parameter has been deprecated in commercial and GCC cloud instances. Use the new Set-CsPhoneNumberAssignment cmdlet instead. + +Assigns a hybrid (on-premise) telephone number to the application instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineAudioConferencingRoutingPolicy.md similarity index 96% rename from teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineAudioConferencingRoutingPolicy.md index a1b9ec1f59..8a6bc07058 100644 --- a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineAudioConferencingRoutingPolicy.md @@ -1,177 +1,178 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineaudioconferencingroutingpolicy -title: Set-CsOnlineAudioConferencingRoutingPolicy -schema: 2.0.0 ---- - -# Set-CsOnlineAudioConferencingRoutingPolicy - -## SYNOPSIS - -This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. - -## SYNTAX - -```powershell -Set-CsOnlineAudioConferencingRoutingPolicy [-Description ] [[-Identity] ] - [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. - -To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." - -The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. - -Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsOnlineAudioConferencingRoutingPolicy -Identity "Policy 1" -OnlinePstnUsages "US and Canada" -``` - -Sets the Online Audio Conferencing Routing Policy "Policy 1" value of "OnlinePstnUsages" to "US and Canada". - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the Online Audio Conferencing Routing Policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnlinePstnUsages - -A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio conferencing routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteType - -For internal use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) -[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) -[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) -[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineaudioconferencingroutingpolicy +schema: 2.0.0 +title: Set-CsOnlineAudioConferencingRoutingPolicy +--- + +# Set-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. + +## SYNTAX + +```powershell +Set-CsOnlineAudioConferencingRoutingPolicy [-Description ] [[-Identity] ] + [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsOnlineAudioConferencingRoutingPolicy -Identity "Policy 1" -OnlinePstnUsages "US and Canada" +``` + +Sets the Online Audio Conferencing Routing Policy "Policy 1" value of "OnlinePstnUsages" to "US and Canada". + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnUsages + +A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio conferencing routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType + +For internal use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge.md similarity index 97% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge.md index a0d2c3d32d..63c5b22606 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingBridge.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingbridge applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingBridge -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingbridge +schema: 2.0.0 +title: Set-CsOnlineDialInConferencingBridge --- # Set-CsOnlineDialInConferencingBridge @@ -43,14 +45,14 @@ The `Set-CsOnlineDialInConferencingBridge` cmdlet can be used to set the default ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingBridge -Name "Conference Bridge" -DefaultServiceNumber 14255551234 ``` This example sets the default dial-in phone number to 14255551234 for the audio conferencing bridge named "Conference Bridge". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $bridge = Get-CsOnlineDialInConferencingBridge -Name "Conference Bridge" @@ -63,45 +65,54 @@ This example changes the name of a conference bridge by creating a conference br ## PARAMETERS -### -Identity -Specifies the globally-unique identifier (GUID) for the audio conferencing bridge to be modified. +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to a Microsoft audio conferencing bridge object to the cmdlet rather than set individual parameter values. +### -DefaultServiceNumber +Specifies the default phone number to be used on the Microsoft audio conferencing bridge. +The default number is used in meeting invitations. + +The DefaultServiceNumber must be assigned to the audio conferencing bridge. +Also, when the default service number is changed, the service number of existing users will not be changed. ```yaml -Type: ConferencingBridge +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Specifies the name of the audio conferencing bridge to be modified. +### -DomainController +Specifies the domain controller that's used by the cmdlet to read or write the specified data. +Valid inputs for this parameter include: + +Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com. + +Computer name: -DomainController atl-cs-001 ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: +Aliases: DC applicable: Microsoft Teams Required: False @@ -111,13 +122,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams Required: False @@ -127,54 +140,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultServiceNumber -Specifies the default phone number to be used on the Microsoft audio conferencing bridge. -The default number is used in meeting invitations. - -The DefaultServiceNumber must be assigned to the audio conferencing bridge. -Also, when the default service number is changed, the service number of existing users will not be changed. +### -Identity +Specifies the globally-unique identifier (GUID) for the audio conferencing bridge to be modified. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter include: - -Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com. - -Computer name: -DomainController atl-cs-001 +### -Instance +Allows you to pass a reference to a Microsoft audio conferencing bridge object to the cmdlet rather than set individual parameter values. ```yaml -Type: Fqdn +Type: ConferencingBridge Parameter Sets: (All) -Aliases: DC +Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Name +Specifies the name of the audio conferencing bridge to be modified. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber.md similarity index 99% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber.md index a64dcc2c2b..2410893747 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingservicenumber applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingServiceNumber -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Set-CsOnlineDialInConferencingServiceNumber --- # Set-CsOnlineDialInConferencingServiceNumber @@ -87,7 +89,7 @@ Ukrainian ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingServiceNumber -Identity +14255551234 -PrimaryLanguage de-de -SecondaryLanguages en-us, ja-jp, en-gb ``` @@ -96,46 +98,52 @@ This example sets the primary language to German (Germany) and the secondary lan ## PARAMETERS -### -Identity -Specifies the default dial-in service number string. -The service number can be specified in the following formats: E.164 number, +\ and tel:\. +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to the Office 365 audio service number object to the cmdlet rather than set individual parameter values. +### -DomainController +Specifies the domain controller that's used by the cmdlet to read or write the specified data. +Valid inputs for this parameter include: + +Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com. + +Computer name: -DomainController atl-cs-001 ```yaml -Type: ConferencingServiceNumber +Type: Fqdn Parameter Sets: (All) -Aliases: +Aliases: DC applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams Required: False @@ -145,40 +153,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter include: - -Fully qualified domain name (FQDN): -DomainController atl-cs-001.Contoso.com. - -Computer name: -DomainController atl-cs-001 +### -Identity +Specifies the default dial-in service number string. +The service number can be specified in the following formats: E.164 number, +\ and tel:\. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: DC +Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Instance +Allows you to pass a reference to the Office 365 audio service number object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter +Type: ConferencingServiceNumber Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings.md similarity index 99% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings.md index 26cf1b24c2..3442f1506e 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingTenantSettings.md @@ -1,9 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingtenantsettings -applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingTenantSettings schema: 2.0.0 +title: Set-CsOnlineDialInConferencingTenantSettings --- # Set-CsOnlineDialInConferencingTenantSettings @@ -41,7 +43,7 @@ The following parameters are not applicable to Teams: EnableDialOutJoinConfirmat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingTenantSettings -EnableEntryExitNotifications $True -EnableNameRecording $True -PinLength 7 ``` @@ -49,7 +51,7 @@ Set-CsOnlineDialInConferencingTenantSettings -EnableEntryExitNotifications $True This example sets the tenant's conferencing settings to enable entry and exit notifications supported by name recording. The PIN length is set to 7. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineDialInConferencingTenantSettings -SendEmailFromOverride $true -SendEmailFromAddress admin@contoso.com -SendEmailFromDisplayName "Conferencing Administrator" ``` @@ -93,7 +95,7 @@ Accept wildcard characters: False ### -AllowFederatedUsersToDialOutToThirdParty -Specifies at this scope if dial out to third party participants is allowed. Possible settings are [No|Yes|RequireSameEnterpriseUser]. +Specifies at this scope if dial out to third party participants is allowed. Possible settings are [No|Yes|RequireSameEnterpriseUser]. This parameter is Microsoft internal use only. ```yaml @@ -354,6 +356,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MaskPstnNumbersType +This parameter allows tenant administrators to configure masking of PSTN participant phone numbers in the roster view for Microsoft Teams meetings enabled for Audio Conferencing, scheduled within the organization. + +Possible values are: +- MaskedForExternalUsers (masked to external users) +- MaskedForAllUsers (masked for everyone) +- NoMasking (visible to everyone) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: MaskedForExternalUsers +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MigrateServiceNumbersOnCrossForestMove Specifies whether service numbers assigned to the tenant should be migrated to the new forest of the tenant when the tenant is migrated cross region. If false, service numbers will be released back to stock once the migration completes. This settings does not apply to ported-in numbers that are always migrated. @@ -510,26 +532,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaskPstnNumbersType -This parameter allows tenant administrators to configure masking of PSTN participant phone numbers in the roster view for Microsoft Teams meetings enabled for Audio Conferencing, scheduled within the organization. - -Possible values are: -- MaskedForExternalUsers (masked to external users) -- MaskedForAllUsers (masked for everyone) -- NoMasking (visible to everyone) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: MaskedForExternalUsers -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingUser.md similarity index 98% rename from teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingUser.md index a0768687dc..a24102c421 100644 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineDialInConferencingUser.md @@ -1,18 +1,17 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencinguser -applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingUser schema: 2.0.0 +title: Set-CsOnlineDialInConferencingUser --- # Set-CsOnlineDialInConferencingUser ## SYNOPSIS -> [!NOTE] -> The AllowPSTNOnlyMeetings, ResetConferenceId, and ConferenceId parameters will be deprecated on Jan 31, 2022. To allow Teams meeting participants joining via the PSTN to bypass the lobby, use the AllowPSTNUsersToBypassLobby of the [Set-CsTeamsMeetingPolicy cmdlet](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingpolicy). The capabilities associated with the ResetConferenceId and ConferenceId parameters are no longer supported. - Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of a user that has been enabled for Microsoft's audio conferencing service. ## SYNTAX @@ -40,16 +39,19 @@ The `Set-CsOnlineDialInConferencingUser` cmdlet is used to modify properties for This cmdlet will not work for users with third-party conferencing providers. The cmdlet will verify that the correct license is assigned to the user. +> [!NOTE] +> The AllowPSTNOnlyMeetings, ResetConferenceId, and ConferenceId parameters will be deprecated on Jan 31, 2022. To allow Teams meeting participants joining via the PSTN to bypass the lobby, use the AllowPSTNUsersToBypassLobby of the [Set-CsTeamsMeetingPolicy cmdlet](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingpolicy). The capabilities associated with the ResetConferenceId and ConferenceId parameters are no longer supported. + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -ResetLeaderPin -ServiceNumber 14255037265 ``` This example shows how to reset the meeting leader's PIN and set the audio conferencing provider default meeting phone number. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conference Bridge" ``` @@ -58,31 +60,30 @@ This example sets a user's conference bridge assignment. ## PARAMETERS -### -Identity -Specifies the Identity of the user account to be to be modified. -A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. +### -AllowPSTNOnlyMeetings +If true, non-authenticated users can start meetings. +If false, non-authenticated callers wait in the lobby until an authenticated user joins, thereby starting the meeting. +An authenticated user is a user who joins the meeting using a Skype for Business client, or the organizer that joined the meeting via dial-in conferencing and was authenticated by a PIN number. +The default is false. ```yaml -Type: UserIdParameter +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantDomain -Specifies the domain name for the tenant or organization. - -This parameter is reserved for internal Microsoft use. +### -AllowTollFreeDialIn +If toll-free numbers are available in your Microsoft Audio Conferencing bridge, this parameter controls if they can be used to join the meetings of a given user. This setting can ONLY be managed using the TeamsAudioConferencingPolicy. By default, AllowTollFreeDialin is always set to True. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -94,17 +95,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPSTNOnlyMeetings -If true, non-authenticated users can start meetings. -If false, non-authenticated callers wait in the lobby until an authenticated user joins, thereby starting the meeting. -An authenticated user is a user who joins the meeting using a Skype for Business client, or the organizer that joined the meeting via dial-in conferencing and was authenticated by a PIN number. -The default is false. - +### -AsJob +The parameter is used to run commands as background jobs. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -202,6 +198,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Specifies the Identity of the user account to be to be modified. +A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). +You can also reference a user account by using the user's Active Directory distinguished name. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResetLeaderPin Specifies whether to reset the meeting organizer or leaders PIN for meetings. @@ -322,8 +336,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TollFreeServiceNumber -Specifies a toll-free phone number to be used by the user. This number is then used in meeting invitations. The toll-free number can be specified in the following formats: E.164 number, +\ and tel:\. +### -TenantDomain +Specifies the domain name for the tenant or organization. + +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -338,27 +354,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf parameter is not implemented for this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTollFreeDialIn -If toll-free numbers are available in your Microsoft Audio Conferencing bridge, this parameter controls if they can be used to join the meetings of a given user. This setting can ONLY be managed using the TeamsAudioConferencingPolicy. By default, AllowTollFreeDialin is always set to True. +### -TollFreeServiceNumber +Specifies a toll-free phone number to be used by the user. This number is then used in meeting invitations. The toll-free number can be specified in the following formats: E.164 number, +\ and tel:\. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -370,12 +370,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsJob -The parameter is used to run commands as background jobs. +### -WhatIf +The WhatIf parameter is not implemented for this cmdlet. + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi +applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md similarity index 96% rename from teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md index 289ee4575e..5edaa5b1a3 100644 --- a/teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md @@ -1,18 +1,30 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineenhancedemergencyservicedisclaimer applicable: Microsoft Teams -title: Set-CsOnlineEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Set-CsOnlineEnhancedEmergencyServiceDisclaimer --- # Set-CsOnlineEnhancedEmergencyServiceDisclaimer ## SYNOPSIS +You can use Get-CsOnlineEnhancedEmergencyServiceDisclaimer to see the status of the emergency service disclaimer. + +## SYNTAX + +``` +Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion [-Version ] [-ForceAccept] + [-Tenant ] [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION When using Microsoft Teams PSTN Calling Services you need to record your organization's acceptance of the enhanced emergency service terms and conditions. This is done per country/region and it needs to be done before you can provide PSTN calling services to Microsoft Teams users in the country/region. @@ -22,23 +34,15 @@ when you create an emergency address in a country/region. Any tenant administrator can accept the terms and conditions and it only needs to be done once per country/region. -As the output the cmdlet will show the emergency service disclaimer and that it has been accepted. You can use Get-CsOnlineEnhancedEmergencyServiceDisclaimer to see the status of the emergency service disclaimer. +As the output the cmdlet will show the emergency service disclaimer and that it has been accepted. -## SYNTAX - -``` -Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion [-Version ] [-ForceAccept] - [-Tenant ] [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION You must run this cmdlet prior to assigning Microsoft Calling Plan phone numbers and locations to voice enabled users or accept the similar disclaimer in the Teams admin center. Microsoft Calling Plan phone numbers are available in several countries/regions, see [Country and region availability for Audio Conferencing and Calling Plans](https://learn.microsoft.com/MicrosoftTeams/country-and-region-availability-for-audio-conferencing-and-calling-plans/country-and-region-availability-for-audio-conferencing-and-calling-plans) ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion US ``` @@ -48,13 +52,13 @@ version of the enhanced emergency service terms and conditions. ## PARAMETERS -### -CountryOrRegion -Specifies the region or country whose terms and conditions you wish to accept. You need to use the ISO 31661-1 alpha-2 2 letter code for the country. For example for the United States it must be specified as "US" and for Denmark it must be specified as "DK". +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -63,13 +67,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -CountryOrRegion +Specifies the region or country whose terms and conditions you wish to accept. You need to use the ISO 31661-1 alpha-2 2 letter code for the country. For example for the United States it must be specified as "US" and for Denmark it must be specified as "DK". ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisCivicAddress.md similarity index 97% rename from teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisCivicAddress.md index 49f8ab38fe..5a6d53b2ef 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisCivicAddress.md @@ -1,26 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress applicable: Microsoft Teams -title: Set-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress +schema: 2.0.0 +title: Set-CsOnlineLisCivicAddress --- # Set-CsOnlineLisCivicAddress ## SYNOPSIS -Use the \`Set-CsOnlineLisCivicAddress\` cmdlet to modify an existing civic address which has not been validated. -Validated civic addresses cannot be modified. - -> [!IMPORTANT] -> Due to a current issue, the parameters **-CompanyName** and **-CountryOrRegion** are required as an interim workaround for this cmdlet. - -> [!Note] -> This cmdlet is only available for public use with limited countries and certain fields. The remaining countries and fields are for Microsoft internal use only. +Use the cmdlet to modify an existing civic address which has not been validated. ## SYNTAX @@ -35,6 +29,11 @@ Set-CsOnlineLisCivicAddress -CivicAddressId [-CompanyName ] [-Com ``` ## DESCRIPTION +Validated civic addresses cannot be modified. + +> [!IMPORTANT] +> Due to a current issue, the parameters **-CompanyName** and **-CountryOrRegion** are required as an interim workaround for this cmdlet. + Use the `Set-CsOnlineLisCivicAddress` cmdlet to modify limited fields of an existing civic address. Editing address using this cmdlet is restricted to the following countries/regions: @@ -42,6 +41,9 @@ Australia, Brazil, Canada, Croatia, Czech Republic, Estonia, Hong Kong, Hungary, If the user runs this cmdlet on one of the unsupported countries, it may interfere with number assignment and potentially is against regulatory requirements, so public use of the API is limited to the above countries/regions. +> [!NOTE] +> This cmdlet is only available for public use with limited countries and certain fields. The remaining countries and fields are for Microsoft internal use only. + ## EXAMPLES ### Example 1 @@ -60,24 +62,25 @@ This example modifies the latitude, longitude and ELIN name of the civic address ## PARAMETERS -### -CivicAddressId -Specifies the unique identifier of the civic address to be modified. +### -City +Specifies a new city for the civic address. Publicly editable. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -City -Specifies a new city for the civic address. Publicly editable. +### -CityAlias +Short form of the city name. +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -92,17 +95,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias -Short form of the city name. -This parameter is reserved for internal Microsoft use. +### -CivicAddressId +Specifies the unique identifier of the civic address to be modified. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -126,7 +128,7 @@ Accept wildcard characters: False ``` ### -CompanyTaxId -Used to store TaxId for regulatory reasons. +Used to store TaxId for regulatory reasons. This parameter is reserved for internal Microsoft use. ```yaml @@ -142,6 +144,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confidence +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm The Confirm switch causes the command to pause processing and requires confirmation to proceed. @@ -160,7 +177,7 @@ Accept wildcard characters: False ### -CountryOrRegion Specifies a new country or region for the civic address. -For public use, restricted to the following countries: +For public use, restricted to the following countries: **AU, BR, CA, HR, CZ, EE, HK, HU, IL, JP, LV, LT, MX, NZ, PL, PR, RO, SG, KR, SI, ZA, US** @@ -193,6 +210,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Elin +Specifies the Emergency Location Identification Number. +This is used in Direct Routing EGW scenarios. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. @@ -246,33 +280,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PostalCode -Specifies the new postal code of the civic address. Publicly editable. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostDirectional -Specifies the new directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". - +### -IsAzureMapValidationRequired This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -281,11 +295,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PreDirectional -Specifies the new directional attribute of the civic address which precedes the street name. -For example, "425 NE Smith Avenue ". - -This parameter is reserved for internal Microsoft use. +### -Latitude +Specifies the angular distance of a place north or south of the earth's equator in the decimal degrees format. Publicly editable. ```yaml Type: String @@ -300,8 +311,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StateOrProvince -Specifies the new state or province of the civic address. Publicly editable. +### -Longitude +Specifies the angular distance of a place east or west of the meridian at Greenwich, England, in the decimal degrees format. Publicly editable. ```yaml Type: String @@ -316,8 +327,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreetName -Specifies the new street name of the civic address. Publicly editable. +### -PostalCode +Specifies the new postal code of the civic address. Publicly editable. ```yaml Type: String @@ -332,9 +343,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreetSuffix -Specifies the new modifier of the street name of the new civic address. -The street suffix will typically be something like street, avenue, way, or boulevard. +### -PostDirectional +Specifies the new directional attribute of the civic address which follows the street name. +For example, "425 Smith Avenue NE". This parameter is reserved for internal Microsoft use. @@ -351,8 +362,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ValidationStatus -Microsoft internal use only +### -PreDirectional +Specifies the new directional attribute of the civic address which precedes the street name. +For example, "425 NE Smith Avenue ". + +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -367,30 +381,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confidence -This parameter is reserved for internal Microsoft use. +### -StateOrProvince +Specifies the new state or province of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -399,9 +397,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Elin -Specifies the Emergency Location Identification Number. -This is used in Direct Routing EGW scenarios. +### -StreetName +Specifies the new street name of the civic address. Publicly editable. ```yaml Type: String @@ -416,8 +413,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Latitude -Specifies the angular distance of a place north or south of the earth's equator in the decimal degrees format. Publicly editable. +### -StreetSuffix +Specifies the new modifier of the street name of the new civic address. +The street suffix will typically be something like street, avenue, way, or boulevard. + +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -432,8 +432,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Longitude -Specifies the angular distance of a place east or west of the meridian at Greenwich, England, in the decimal degrees format. Publicly editable. +### -ValidationStatus +Microsoft internal use only ```yaml Type: String @@ -448,17 +448,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsAzureMapValidationRequired -This parameter is reserved for internal Microsoft use. +### -WhatIf +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi +applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsOnlineLisLocation.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisLocation.md similarity index 93% rename from teams/teams-ps/teams/Set-CsOnlineLisLocation.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisLocation.md index d93fd56f49..918db3ee0c 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisLocation.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation applicable: Microsoft Teams -title: Set-CsOnlineLisLocation -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation +schema: 2.0.0 +title: Set-CsOnlineLisLocation --- # Set-CsOnlineLisLocation @@ -45,77 +46,69 @@ This example changes the location description of the location specified by its l ## PARAMETERS -### -CivicAddressId -Specifies the unique identifier of the civic address that contains the location to be modified. -Civic address identities can be discovered by using the \`Get-CsOnlineLisCivicAddress\` cmdlet. +### -City + +> Applicable: Microsoft Teams + +Specifies the city of the civic address. **Note:** This parameter is not supported and will be deprecated. ```yaml -Type: Guid +Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -Specifies the unique identifier of the location to be modified. Location identities can be discovered by using the \`Get-CsOnlineLisLocation\` cmdlet. - -```yaml -Type: Guid -Parameter Sets: UseLocationId -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +### -CityAlias -### -City -Specifies the city of the civic address. +> Applicable: Microsoft Teams -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. ```yaml Type: String -Parameter Sets: UseCivicAddressId +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -CityAlias +### -CivicAddressId -**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. +> Applicable: Microsoft Teams + +Specifies the unique identifier of the civic address that contains the location to be modified. +Civic address identities can be discovered by using the \`Get-CsOnlineLisCivicAddress\` cmdlet. + +**Note:** This parameter is not supported and will be deprecated. ```yaml -Type: String -Parameter Sets: (All) +Type: Guid +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` ### -CompanyName + +> Applicable: Microsoft Teams + Specifies the name of your organization. **Note:** This parameter is not supported and will be deprecated. @@ -124,7 +117,6 @@ Specifies the name of your organization. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -134,6 +126,9 @@ Accept wildcard characters: False ``` ### -CompanyTaxId + +> Applicable: Microsoft Teams + The company tax ID. **Note:** This parameter is not supported and will be deprecated. @@ -142,7 +137,6 @@ The company tax ID. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -153,13 +147,14 @@ Accept wildcard characters: False ### -Confidence +> Applicable: Microsoft Teams + **Note:** This parameter is not supported and will be deprecated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -168,7 +163,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Microsoft Teams + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CountryOrRegion + +> Applicable: Microsoft Teams + Specifies the country or region of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -177,7 +193,6 @@ Specifies the country or region of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -195,7 +213,6 @@ Specifies an administrator defined description of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -205,6 +222,9 @@ Accept wildcard characters: False ``` ### -Elin + +> Applicable: Microsoft Teams + Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. **Note:** You can set or change the ELIN, but you can't clear its value. If you need to clear the value, you should recreate the location. @@ -213,7 +233,6 @@ Specifies the Emergency Location Identification Number. This is used in Direct R Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -222,7 +241,30 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Force + +> Applicable: Microsoft Teams + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HouseNumber + +> Applicable: Microsoft Teams + Specifies the numeric portion of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -231,7 +273,6 @@ Specifies the numeric portion of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -241,6 +282,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Microsoft Teams + Specifies the numeric suffix of the civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". @@ -250,7 +294,6 @@ For example, if the property was multiplexed, the HouseNumberSuffix parameter wo Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -259,26 +302,29 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -Latitude -Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. +### -IsAzureMapValidationRequired -**Note:** This parameter is not supported and will be deprecated. +> Applicable: Microsoft Teans + +This parameter is reserved for internal Microsoft use. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -Longitude -Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. +### -Latitude + +> Applicable: Microsoft Teams + +Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. **Note:** This parameter is not supported and will be deprecated. @@ -286,7 +332,6 @@ Specifies the angular distance of a place east or west of the meridian at Greenw Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -294,14 +339,17 @@ Default value: None Accept pipeline input: True Accept wildcard characters: False ``` + ### -Location + +> Applicable: Microsoft Teams + Specifies an administrator defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". ```yaml Type: String Parameter Sets: UseLocationId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -310,35 +358,36 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -PostalCode -Specifies the postal code of the civic address. +### -LocationId -**Note:** This parameter is not supported and will be deprecated. +> Applicable: Microsoft Teams + +Specifies the unique identifier of the location to be modified. Location identities can be discovered by using the \`Get-CsOnlineLisLocation\` cmdlet. ```yaml -Type: String -Parameter Sets: UseCivicAddressId +Type: Guid +Parameter Sets: UseLocationId Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -PostDirectional -Specifies the directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". +### -Longitude + +> Applicable: Microsoft Teams + +Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. **Note:** This parameter is not supported and will be deprecated. ```yaml Type: String -Parameter Sets: UseCivicAddressId +Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -346,9 +395,11 @@ Default value: None Accept pipeline input: True Accept wildcard characters: False ``` +### -PostalCode -### -PreDirectional -Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue ". +> Applicable: Microsoft Teams + +Specifies the postal code of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -356,7 +407,6 @@ Specifies the directional attribute of the civic address which precedes the stre Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -365,8 +415,12 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -StateOrProvince -Specifies the state or province of the civic address. +### -PostDirectional + +> Applicable: Microsoft Teams + +Specifies the directional attribute of the civic address which follows the street name. +For example, "425 Smith Avenue NE". **Note:** This parameter is not supported and will be deprecated. @@ -374,7 +428,6 @@ Specifies the state or province of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -383,8 +436,11 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -StreetName -Specifies the street name of the civic address. +### -PreDirectional + +> Applicable: Microsoft Teams + +Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue ". **Note:** This parameter is not supported and will be deprecated. @@ -392,7 +448,6 @@ Specifies the street name of the civic address. Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -401,8 +456,11 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -StreetSuffix -Specifies a modifier of the street name of the civic address. The street suffix will typically be something like street, avenue, way, or boulevard. +### -StateOrProvince + +> Applicable: Microsoft Teams + +Specifies the state or province of the civic address. **Note:** This parameter is not supported and will be deprecated. @@ -410,7 +468,6 @@ Specifies a modifier of the street name of the civic address. The street suffix Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teans Required: False Position: Named @@ -419,41 +476,50 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -IsAzureMapValidationRequired -This parameter is reserved for internal Microsoft use. +### -StreetName + +> Applicable: Microsoft Teams + +Specifies the street name of the civic address. + +**Note:** This parameter is not supported and will be deprecated. ```yaml Type: String Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teans Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -StreetSuffix + +> Applicable: Microsoft Teans + +Specifies a modifier of the street name of the civic address. The street suffix will typically be something like street, avenue, way, or boulevard. + +**Note:** This parameter is not supported and will be deprecated. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: UseCivicAddressId Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -461,23 +527,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineLisPort.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisPort.md similarity index 94% rename from teams/teams-ps/teams/Set-CsOnlineLisPort.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisPort.md index 39f8049001..b32f9c2a26 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisPort.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisPort.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport applicable: Microsoft Teams -title: Set-CsOnlineLisPort -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport +schema: 2.0.0 +title: Set-CsOnlineLisPort --- # Set-CsOnlineLisPort @@ -50,13 +51,15 @@ Example 3 creates the association between port "12174" and LocationId "efd7273e- ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + If ChassisID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise, (different sub type, such as Interface Name), then this value must be in a string format as set on the switch ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -65,32 +68,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -Specifies the unique identifier of the location to be modified. +### -Confirm -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +> Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PortID -If the PortID subtype is a MAC Address, this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise (different subtype, such as Interface Name), this value must be in a string format as set on the switch. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -98,13 +87,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the port. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -114,6 +105,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -122,7 +116,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -132,13 +125,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -147,14 +142,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationId + +> Applicable: Microsoft Teams + +Specifies the unique identifier of the location to be modified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -163,30 +178,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore -This parameter is reserved for internal Microsoft use. +### -PortID + +> Applicable: Microsoft Teams + +If the PortID subtype is a MAC Address, this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise (different subtype, such as Interface Name), this value must be in a string format as set on the switch. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -196,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -203,7 +225,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSubnet.md similarity index 99% rename from teams/teams-ps/teams/Set-CsOnlineLisSubnet.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSubnet.md index ae42f3ce2d..54b8d13907 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSubnet.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelissubnet applicable: Microsoft Teams -title: Set-CsOnlineLisSubnet -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelissubnet +schema: 2.0.0 +title: Set-CsOnlineLisSubnet --- # Set-CsOnlineLisSubnet diff --git a/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSwitch.md similarity index 93% rename from teams/teams-ps/teams/Set-CsOnlineLisSwitch.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSwitch.md index 71e862e8a2..920cc344b9 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisSwitch.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch applicable: Microsoft Teams -title: Set-CsOnlineLisSwitch -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch +schema: 2.0.0 +title: Set-CsOnlineLisSwitch --- # Set-CsOnlineLisSwitch @@ -36,6 +37,9 @@ Example 1 creates a switch with Chassis ID "B8-BE-BF-4A-A3-00", and associates i ## PARAMETERS ### -ChassisID + +> Applicable: Microsoft Teams + If ChassisID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise, (different sub type, such as Interface Name), then this value must be in a string format as set on the switch @@ -43,7 +47,6 @@ Otherwise, (different sub type, such as Interface Name), then this value must be Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -52,16 +55,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -The name for this location. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -69,13 +74,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the switch. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -85,6 +92,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -93,7 +103,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -103,13 +112,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -118,30 +129,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NCSApiUrl -This parameter is reserved for internal Microsoft use. +### -LocationId + +> Applicable: Microsoft Teams + +The name for this location. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore +### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -150,14 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -167,6 +184,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -174,7 +194,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint.md similarity index 95% rename from teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint.md index 75045602f9..78756504a2 100644 --- a/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineLisWirelessAccessPoint.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint applicable: Microsoft Teams -title: Set-CsOnlineLisWirelessAccessPoint -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint +schema: 2.0.0 +title: Set-CsOnlineLisWirelessAccessPoint --- # Set-CsOnlineLisWirelessAccessPoint @@ -47,13 +48,15 @@ Example 2 creates the wireless access point with Chassis ID "F0-6E-0B-C2-04-*", ## PARAMETERS ### -BSSID + +> Applicable: Microsoft Teams + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. If an entry with the specified BSSID value does not exist, a new WAP will be created. If an entry with the specified BSSID already exists, that entry will be replaced. It can be presented in wildcard format. The wildcard '*' can be on either the last one or two character(s). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: 1 @@ -62,16 +65,18 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -LocationId -The name for this location. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Specifies the administrator defined description of the WAP. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -95,6 +102,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -103,7 +113,6 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -113,13 +122,15 @@ Accept wildcard characters: False ``` ### -IsDebug + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -128,30 +139,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NCSApiUrl -This parameter is reserved for internal Microsoft use. +### -LocationId + +> Applicable: Microsoft Teams + +The name for this location. ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStore +### -NCSApiUrl + +> Applicable: Microsoft Teams + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -160,14 +175,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -TargetStore + +> Applicable: Microsoft Teams + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -177,6 +194,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -184,7 +204,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePSTNGateway.md similarity index 95% rename from teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlinePSTNGateway.md index 845a593cc5..a4ed035686 100644 --- a/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePSTNGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway applicable: Microsoft Teams -title: Set-CsOnlinePSTNGateway -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway +schema: 2.0.0 +title: Set-CsOnlinePSTNGateway --- # Set-CsOnlinePSTNGateway @@ -67,21 +68,6 @@ This example modifies the configuration of an SBC with identity (and FQDN) sbc. ## PARAMETERS -### -Identity -The parameter is mandatory when modifying an existing SBC. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -BypassMode Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle. @@ -97,13 +83,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -112,13 +100,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Free-format string to describe the gateway. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -127,13 +117,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Microsoft Teams + Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC from service while it is being updated or during maintenance. Note if the parameter is not set the SBC will be created as disabled (default value -Enabled $false). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -142,6 +134,9 @@ Accept wildcard characters: False ``` ### -FailoverResponseCodes + +> Applicable: Microsoft Teams + If Direct Routing receives any 4xx or 6xx SIP error code in response on outgoing Invite (outgoing means call from a Teams client to PSTN with traffic flow :Teams Client -> Direct Routing -> SBC -> Telephony network) the call is considered completed by default. Setting the SIP codes in this parameter forces Direct Routing on receiving the specified codes try another SBC (if another SBC exists in the voice routing policy of the user). @@ -153,7 +148,6 @@ Setting this parameter overwrites the default values, so if you want to include Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 408, 503, 504 @@ -162,13 +156,15 @@ Accept wildcard characters: False ``` ### -FailoverTimeSeconds + +> Applicable: Microsoft Teams + When set to 10 (default value), outbound calls that are not answered by the gateway within 10 seconds are routed to the next available trunk; if there are no additional trunks, then the call is automatically dropped. In an organization with slow networks and slow gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: 10 @@ -177,13 +173,15 @@ Accept wildcard characters: False ``` ### -ForwardCallHistory + +> Applicable: Microsoft Teams + Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -192,13 +190,15 @@ Accept wildcard characters: False ``` ### -ForwardPai + +> Applicable: Microsoft Teams + Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False). Setting this parameter to $true will render the from header anonymous, in accordance of RFC5379 and RFC3325. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -206,44 +206,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewaySiteId -PSTN Gateway Site Id. +### -GatewayLbrEnabledUserOverride + +> Applicable: Microsoft Teams + +Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: $false Accept pipeline input: False Accept wildcard characters: False ``` -### -GatewayLbrEnabledUserOverride -Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. +### -GatewaySiteId + +> Applicable: Microsoft Teams + +PSTN Gateway Site Id. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: $false +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -GatewaySiteLbrEnabled + +> Applicable: Microsoft Teams + Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is turned on, the SBC will report the site name as defined by tenant administrator. On incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -251,8 +257,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundTeamsNumberTranslationRules -This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. +### -Identity + +> Applicable: Microsoft Teams + +The parameter is mandatory when modifying an existing SBC. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundPSTNNumberTranslationRules +Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. ```yaml Type: Object @@ -265,8 +288,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundPSTNNumberTranslationRules -Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. +### -InboundTeamsNumberTranslationRules +This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. ```yaml Type: Object @@ -294,13 +317,15 @@ Accept wildcard characters: False ``` ### -MaxConcurrentSessions + +> Applicable: Microsoft Teams + Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent session is 90% or higher than this value. If this parameter is not set, the alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -309,13 +334,15 @@ Accept wildcard characters: False ``` ### -MediaBypass + +> Applicable: Microsoft Teams + Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -325,13 +352,14 @@ Accept wildcard characters: False ### -MediaRelayRoutingLocationOverride +> Applicable: Microsoft Teams + Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -339,8 +367,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundTeamsNumberTranslationRules -Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction. +### -OutboundPSTNNumberTranslationRules +Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction. ```yaml Type: Object @@ -353,8 +381,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundPSTNNumberTranslationRules -Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction. +### -OutboundTeamsNumberTranslationRules +Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction. ```yaml Type: Object @@ -368,13 +396,15 @@ Accept wildcard characters: False ``` ### -PidfloSupported + +> Applicable: Microsoft Teams + Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $false @@ -383,13 +413,15 @@ Accept wildcard characters: False ``` ### -ProxySbc + +> Applicable: Microsoft Teams + The FQDN of the proxy SBC. Used in Local Media Optimization configurations. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -398,13 +430,15 @@ Accept wildcard characters: False ``` ### -SendSipOptions + +> Applicable: Microsoft Teams + Defines if an SBC will or will not send the SIP options. If disabled, the SBC will be excluded from Monitoring and Alerting system. We highly recommend that you enable SIP options. Default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: $true @@ -413,13 +447,15 @@ Accept wildcard characters: False ``` ### -SipSignalingPort + +> Applicable: Microsoft Teams + Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. The value must be between 1 and 65535. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -428,6 +464,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -435,7 +474,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePstnUsage.md similarity index 92% rename from teams/teams-ps/teams/Set-CsOnlinePstnUsage.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlinePstnUsage.md index 549dcdcc10..6ba1556e93 100644 --- a/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlinePstnUsage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstnusage applicable: Microsoft Teams -title: Set-CsOnlinePstnUsage -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstnusage +schema: 2.0.0 +title: Set-CsOnlinePstnUsage --- # Set-CsOnlinePstnUsage @@ -29,28 +30,28 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsOnlinePstnUsage -Identity global -Usage @{add="International"} ``` This command adds the string "International" to the current list of available PSTN usages. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsOnlinePstnUsage -Identity global -Usage @{remove="Local"} ``` This command removes the string "Local" from the list of available PSTN usages. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Set-CsOnlinePstnUsage -Usage @{remove="Local"} ``` The command in this example performs the exact same action as the command in Example 2: it removes the "Local" PSTN usage. This example shows the command without the Identity parameter specified. The only Identity available to the Set-CsOnlinePstnUsage cmdlet is the Global identity; omitting the Identity parameter defaults to Global. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> Set-CsOnlinePstnUsage -Usage @{replace="International","Restricted"} ``` diff --git a/teams/teams-ps/teams/Set-CsOnlineSchedule.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineSchedule.md similarity index 95% rename from teams/teams-ps/teams/Set-CsOnlineSchedule.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineSchedule.md index 7f4392b0fa..b2c6a25d60 100644 --- a/teams/teams-ps/teams/Set-CsOnlineSchedule.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineSchedule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineschedule applicable: Microsoft Teams -title: Set-CsOnlineSchedule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineschedule +schema: 2.0.0 +title: Set-CsOnlineSchedule --- # Set-CsOnlineSchedule @@ -25,7 +27,7 @@ The Set-CsOnlineSchedule cmdlet lets you modify the properties of a schedule. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $schedule = Get-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" $schedule.Name = "Christmas Holiday" @@ -34,7 +36,7 @@ Set-CsOnlineSchedule -Instance $schedule This example modifies the name of the schedule that has a Id of fa9081d6-b4f3-5c96-baec-0b00077709e5. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell $schedule = Get-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance.md similarity index 97% rename from teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance.md index f62687992e..f224a202e8 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceApplicationInstance.md @@ -1,22 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceapplicationinstance applicable: Microsoft Teams -title: Set-CsOnlineVoiceApplicationInstance -ms.reviewer: -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceapplicationinstance +schema: 2.0.0 +title: Set-CsOnlineVoiceApplicationInstance --- # Set-CsOnlineVoiceApplicationInstance ## SYNOPSIS -The `Set-CsOnlineVoiceApplicationInstance` modifies an application instance in Microsoft Entra ID. - -**Note**: This cmdlet has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and -[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. +The cmdlet modifies an application instance in Microsoft Entra ID. ## SYNTAX ``` @@ -33,6 +31,9 @@ Set-CsOnlineVoiceApplicationInstance [[-Identity] ] ## DESCRIPTION This cmdlet is used to modify an application instance in Microsoft Entra ID. +**Note**: This cmdlet has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. + ## EXAMPLES ### Example 1 diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoute.md similarity index 97% rename from teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoute.md index e88a324e6f..b19e8b5e9d 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoute.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute applicable: Microsoft Teams -title: Set-CsOnlineVoiceRoute -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute +schema: 2.0.0 +title: Set-CsOnlineVoiceRoute --- # Set-CsOnlineVoiceRoute @@ -31,21 +33,21 @@ This cmdlet is used when configuring Microsoft Phone System Direct Routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -Description "Test Route" ``` This command sets the Description of the Route1 online voice route to "Test Route." -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsOnlineVoiceRoute -Identity Route1 -OnlinePstnUsages @{add="Long Distance"} ``` The command in this example modifies the online voice route with the identity Route1 to add the online PSTN usage Long Distance to the list of usages for this voice route. Long Distance must be in the list of global online PSTN usages (which can be retrieved with a call to the `Get-CsOnlinePstnUsage` cmdlet). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> $x = (Get-CsOnlinePstnUsage).Usage diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy.md similarity index 96% rename from teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy.md index c541ead593..ba69ac21ec 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy applicable: Microsoft Teams -title: Set-CsOnlineVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy +schema: 2.0.0 +title: Set-CsOnlineVoiceRoutingPolicy --- # Set-CsOnlineVoiceRoutingPolicy @@ -31,21 +32,21 @@ Note that simply assigning a user an online voice routing policy will not enable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages @{Add="Long Distance"} ``` The command shown in Example 1 adds the online PSTN usage "Long Distance" to the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsOnlineVoiceRoutingPolicy -Identity "RedmondOnlineVoiceRoutingPolicy" -OnlinePstnUsages @{Remove="Local"} ``` In Example 2, the online PSTN usage "Local" is removed from the per-user online voice routing policy RedmondOnlineVoiceRoutingPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Set-CsOnlineVoiceRoutingPolicy | Where-Object {$_.OnlinePstnUsages -contains "Local"} | Set-CsOnlineVoiceRoutingPolicy -OnlinePstnUsages @{Remove="Local"} ``` diff --git a/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceUser.md similarity index 96% rename from teams/teams-ps/teams/Set-CsOnlineVoiceUser.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceUser.md index d7f09686d0..e5d32acefb 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoiceUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceuser applicable: Microsoft Teams -title: Set-CsOnlineVoiceUser -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceuser +schema: 2.0.0 +title: Set-CsOnlineVoiceUser --- # Set-CsOnlineVoiceUser @@ -15,10 +16,6 @@ ms.reviewer: ## SYNOPSIS Use the `Set-CsOnlineVoiceUser` cmdlet to set the PSTN specific parameters (like telephone numbers and emergency response locations.) -**Note**: This cmdlet has been deprecated. Use the new -[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and -[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. - ## SYNTAX ``` @@ -27,17 +24,20 @@ Set-CsOnlineVoiceUser [-Identity] [-Tenant ] [-Telephone ``` ## DESCRIPTION +**Note**: This cmdlet has been deprecated. Use the new +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineVoiceUser -Identity 3c37e1c7-78f9-4703-82ee-a6b68516794e -TelephoneNumber +14255037311 -LocationID c7c5a17f-00d7-47c0-9ddb-3383229d606b ``` This example sets the telephone number and location for a user identified by the user ObjectID. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineVoiceUser -Identity user@domain.com -TelephoneNumber $null ``` @@ -46,31 +46,6 @@ This example removes the telephone number for a user identified by the user's SI ## PARAMETERS -### -Identity -Specifies the identity of the target user. -Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -You can use the `Get-CsOnlineUser` cmdlet to identify the users you want to modify. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Confirm The Confirm switch causes the command to pause processing and requires confirmation to proceed. @@ -121,6 +96,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Specifies the identity of the target user. +Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +You can use the `Get-CsOnlineUser` cmdlet to identify the users you want to modify. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocationID Specifies the unique identifier of the emergency location to assign to the user. Location identities can be discovered by using the `Get-CsOnlineLisLocation` cmdlet. diff --git a/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailPolicy.md similarity index 94% rename from teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailPolicy.md index e5f0a4f436..7520da75d2 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailPolicy.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy applicable: Microsoft Teams -title: Set-CsOnlineVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy +schema: 2.0.0 +title: Set-CsOnlineVoicemailPolicy --- # Set-CsOnlineVoicemailPolicy ## SYNOPSIS -Modifies an existing Online Voicemail policy. Online Voicemail policies determine whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. +Modifies an existing Online Voicemail policy. ## SYNTAX @@ -41,14 +42,14 @@ Tenant admin would be able to create a customized online voicemail policy to mat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" -MaximumRecordingLength ([TimeSpan]::FromSeconds(60)) ``` The command shown in Example 1 changes the MaximumRecordingLength to 60 seconds for the per-user online voicemail policy CustomOnlineVoicemailPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineVoicemailPolicy -EnableTranscriptionProfanityMasking $false ``` @@ -57,17 +58,32 @@ The command shown in Example 2 changes the EnableTranscriptionProfanityMasking t ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -137,6 +153,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MaximumRecordingLength A duration of voicemail maximum recording length. The length should be between 30 seconds to 10 minutes. @@ -261,37 +293,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings.md similarity index 96% rename from teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md rename to teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings.md index 679bea74c8..0694db61b0 100644 --- a/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsOnlineVoicemailUserSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings applicable: Microsoft Teams -title: Set-CsOnlineVoicemailUserSettings -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings +schema: 2.0.0 +title: Set-CsOnlineVoicemailUserSettings --- # Set-CsOnlineVoicemailUserSettings @@ -31,35 +32,35 @@ For example, tenant admin could enable/disable voicemail, change voicemail promp ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOnlineVoicemailUserSettings -Identity sip:user1@contoso.com -VoicemailEnabled $true ``` This example changes VoicemailEnabled setting to true for the user with SIP URI sip:user1@contoso.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsOnlineVoicemailUserSettings -Identity user2@contoso.com -PromptLanguage "en-US" -OofGreetingFollowCalendarEnabled $false ``` This example changes PromptLanguage setting to "en-US" and OofGreetingFollowCalendarEnabled setting to false for user2@contoso.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsOnlineVoicemailUserSettings -Identity user3@contoso.com -CallAnswerRule PromptOnlyWithTransfer -TransferTarget sip:user4@contoso.com ``` This example changes CallAnswerRule setting to PromptOnlyWithTransfer and set TransferTarget to "sip:user4@contoso.com" for user3@contoso.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsOnlineVoicemailUserSettings -Identity user5@contoso.com -CallAnswerRule VoicemailWithTransferOption -TransferTarget "+14255551234" ``` This example changes CallAnswerRule setting to VoicemailWithTransferOption and set TransferTarget to "+14255551234" for user5@contoso.com.. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Set-CsOnlineVoicemailUserSettings -Identity user6@contoso.com -DefaultGreetingPromptOverwrite "Hi, I am currently not available." ``` @@ -68,35 +69,35 @@ This example changes DefaultGreetingPromptOverwrite setting to "Hi, I am current ## PARAMETERS -### -Identity -The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. +### -CallAnswerRule +The CallAnswerRule parameter represents the value of the call answer rule, which can be any of the following: + +- DeclineCall +- PromptOnly +- PromptOnlyWithTransfer +- RegularVoicemail +- VoicemailWithTransferOption ```yaml -Type: System.String +Type: Object Parameter Sets: (All) Aliases: applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CallAnswerRule -The CallAnswerRule parameter represents the value of the call answer rule, which can be any of the following: - -- DeclineCall -- PromptOnly -- PromptOnlyWithTransfer -- RegularVoicemail -- VoicemailWithTransferOption +### -Confirm +Prompts you for confirmation before executing the command. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False @@ -155,6 +156,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +The Identity parameter represents the ID of the specific user in your organization; this can be either a SIP URI or an Object ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OofGreetingEnabled The OofGreetingEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario. @@ -326,22 +343,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberAssignment.md similarity index 95% rename from teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md rename to teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberAssignment.md index b90380feb3..8cbf93dbe7 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberAssignment.md @@ -1,330 +1,337 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment -applicable: Microsoft Teams -title: Set-CsPhoneNumberAssignment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsPhoneNumberAssignment - -## SYNOPSIS -This cmdlet will assign a phone number to a user or a resource account (online application instance). - -## SYNTAX - -### LocationUpdate (Default) -```powershell -Set-CsPhoneNumberAssignment -PhoneNumber -LocationId [] -``` - -### NetworkSiteUpdate -```powershell -Set-CsPhoneNumberAssignment -PhoneNumber -NetworkSiteId [] -``` - -### Assignment -```powershell -Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType - [-LocationId ] [-NetworkSiteId ] [-AssignmentCategory ] [] -``` - -### Attribute -```powershell -Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled [] -``` - -### ReverseNumberLookup -```powershell -Set-CsPhoneNumberAssignment -PhoneNumber -ReverseNumberLookup [] -``` - -### Notify -```powershell -Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType -Notify [] -``` - -## DESCRIPTION -This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. - -You can also assign a location to a phone number. - -To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlet. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan -``` -This example assigns the Microsoft Calling Plan phone number +1 (206) 555-1234 to the user user1@contoso.com. - -### Example 2 -```powershell -$loc=Get-CsOnlineLisLocation -City Vancouver -Set-CsPhoneNumberAssignment -Identity user2@contoso.com -PhoneNumber +12065551224 -PhoneNumberType CallingPlan -LocationId $loc.LocationId -``` -This example finds the emergency location defined for the corporate location Vancouver and assigns the Microsoft Calling Plan phone number +1 (206) 555-1224 and location to the user user2@contoso.com. - -### Example 3 -```powershell -Set-CsPhoneNumberAssignment -Identity user3@contoso.com -EnterpriseVoiceEnabled $true -``` -This example sets the EnterpriseVoiceEnabled flag on the user user3@contoso.com. - -### Example 4 -```powershell -Set-CsPhoneNumberAssignment -Identity user3@contoso.com -LocationId 'null' -PhoneNumber +12065551226 -PhoneNumberType OperatorConnect -``` -This example removes the emergency location from the phone number for user user3@contoso.com. - -### Example 5 -```powershell -Set-CsPhoneNumberAssignment -Identity cq1@contoso.com -PhoneNumber +14255551225 -PhoneNumberType DirectRouting -``` -This example assigns the Direct Routing phone number +1 (425) 555-1225 to the resource account cq1@contoso.com. - -### Example 6 -```powershell -Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -``` -This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 to the user user4@contoso.com. - -### Example 7 -```powershell -Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occurred } -``` -This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. - -### Example 8 -```powershell -$TempUser = "tempuser@contoso.com" -$OldLoc=Get-CsOnlineLisLocation -City Vancouver -$NewLoc=Get-CsOnlineLisLocation -City Seattle -$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment -foreach ($No in $Numbers) { - Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId - Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -} -``` -This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers, assigning each phone number temporarily with the new location to a user, and then unassigning the phone number again from the user. - -### Example 9 -```powershell -$loc=Get-CsOnlineLisLocation -City Toronto -Set-CsPhoneNumberAssignment -PhoneNumber +12065551224 -LocationId $loc.LocationId -``` -This example shows how to set the location on a phone number. - -### Example 10 -```powershell -$OldLocationId = "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" -$NewLocationId = "951fac72-955e-4734-ab74-cc4c0f761c0b" -# Get all phone numbers in old location -$pns = Get-CsPhoneNumberAssignment -LocationId $OldLocationId -Write-Host $pns.count numbers found in old location $OldLocationId -# Move all those phone numbers to the new location -foreach ($pn in $pns) { - Try { - Set-CsPhoneNumberAssignment -PhoneNumber $pn.TelephoneNumber -LocationId $NewLocationId -ErrorAction Stop - Write-Host $pn.TelephoneNumber was updated to have location $NewLocationId - } - Catch { - Write-Host Could not update $pn.TelephoneNumber with location $NewLocationId - } -} -Write-Host (Get-CsPhoneNumberAssignment -LocationId $OldLocationId).Count numbers found in old location $OldLocationId -Write-Host (Get-CsPhoneNumberAssignment -LocationId $NewLocationId).Count numbers found in new location $NewLocationId -``` -This Example shows how to update the LocationID from an old location to a new location for a set of phone numbers. - -### Example 11 -```powershell -Set-CsPhoneNumberAssignment -Identity user3@contoso.com -PhoneNumber +12065551226 -ReverseNumberLookup 'SkipInternalVoip' -``` -This example shows how to turn off reverse number lookup (RNL) on a phone number. When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. This example is only applicable for Direct Routing phone numbers. - -### Example 12 -```powershell -Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -AssignmentCategory Private -``` -This example shows how to assign a private phone number (incoming calls only) to a user. -### Example 13 -```powershell -Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -LocationId "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" -Notify -``` -This example shows how to send an email to Teams phone users informing them about the new telephone number assignment. Note: For assignment of India telephone numbers provided by Airtel, Teams Phone users will automatically receive an email outlining the usage guidelines and restrictions. This notification is mandatory and cannot be opted out of. - -## PARAMETERS - -### -AssignmentCategory -This parameter indicates the phone number assignment category if it isn't the primary phone number. For example, a Private line can be assigned to a user using '-AssignmentCategory Private'. - -```yaml -Type: System.String -Parameter Sets: (Assignment) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnterpriseVoiceEnabled -Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. - -This parameter is mutual exclusive with PhoneNumber. - -```yaml -Type: System.Boolean -Parameter Sets: (Attribute) -Aliases: -Applicable: Microsoft Teams - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or -resource account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationId -The LocationId of the location to assign to the specific user. You can get it using Get-CsOnlineLisLocation. You can set the location on both assigned and unassigned -phone numbers. - -Removal of location from a phone number is supported for Direct Routing numbers and Operator Connect numbers that are not managed by the Service Desk. -If you want to remove the location, use the string value null for LocationId. - -```yaml -Type: System.String -Parameter Sets: (Assignment, LocationUpdate) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSiteId -ID of a network site. A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. - -```yaml -Type: System.String -Parameter Sets: (Assignment) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can't have "tel:" prefixed. - -We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. - -Setting a phone number will automatically set EnterpriseVoiceEnabled to True. - -```yaml -Type: System.String -Parameter Sets: (Assignment, LocationUpdate) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumberType -The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. - -```yaml -Type: System.String -Parameter Sets: (Assignment) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReverseNumberLookup -This parameter is used to control the behavior of reverse number lookup (RNL) for a phone number.When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. - -```yaml -Type: String -Parameter Sets: (ReverseNumberLookupUpdate, Assignment) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notify -Sends an email to Teams phone user about new telephone number assignment. - -```yaml -Type: Switch -Parameter Sets: (Assignment) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 3.0.0 or later. The parameter set LocationUpdate was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The parameter set NetworkSiteUpdate was introduced in Teams PowerShell module 5.5.1-preview. - -The cmdlet is only available in commercial and GCC cloud instances. - -If a user or resource account has a phone number set in Active Directory on-premises and synched into Microsoft 365, you can't use Set-CsPhoneNumberAssignment to set the phone number. You will have to clear the phone number from the on-premises Active Directory and let that change sync into Microsoft 365 first. - -The previous command for assigning phone numbers to users Set-CsUser had the parameter HostedVoiceMail. Setting HostedVoiceMail for Microsoft Teams users is no longer -necessary and that is why the parameter is not available on Set-CsPhoneNumberAssignment. - -## RELATED LINKS -[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) - -[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment +schema: 2.0.0 +title: Set-CsPhoneNumberAssignment +--- + +# Set-CsPhoneNumberAssignment + +## SYNOPSIS +This cmdlet will assign a phone number to a user or a resource account (online application instance). + +## SYNTAX + +### LocationUpdate (Default) +```powershell +Set-CsPhoneNumberAssignment -PhoneNumber -LocationId [] +``` + +### NetworkSiteUpdate +```powershell +Set-CsPhoneNumberAssignment -PhoneNumber -NetworkSiteId [] +``` + +### Assignment +```powershell +Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType + [-LocationId ] [-NetworkSiteId ] [-AssignmentCategory ] [] +``` + +### Attribute +```powershell +Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled [] +``` + +### ReverseNumberLookup +```powershell +Set-CsPhoneNumberAssignment -PhoneNumber -ReverseNumberLookup [] +``` + +### Notify +```powershell +Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType -Notify [] +``` + +## DESCRIPTION +This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. + +You can also assign a location to a phone number. + +To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber +12065551234 -PhoneNumberType CallingPlan +``` +This example assigns the Microsoft Calling Plan phone number +1 (206) 555-1234 to the user user1@contoso.com. + +### Example 2 +```powershell +$loc=Get-CsOnlineLisLocation -City Vancouver +Set-CsPhoneNumberAssignment -Identity user2@contoso.com -PhoneNumber +12065551224 -PhoneNumberType CallingPlan -LocationId $loc.LocationId +``` +This example finds the emergency location defined for the corporate location Vancouver and assigns the Microsoft Calling Plan phone number +1 (206) 555-1224 and location to the user user2@contoso.com. + +### Example 3 +```powershell +Set-CsPhoneNumberAssignment -Identity user3@contoso.com -EnterpriseVoiceEnabled $true +``` +This example sets the EnterpriseVoiceEnabled flag on the user user3@contoso.com. + +### Example 4 +```powershell +Set-CsPhoneNumberAssignment -Identity user3@contoso.com -LocationId 'null' -PhoneNumber +12065551226 -PhoneNumberType OperatorConnect +``` +This example removes the emergency location from the phone number for user user3@contoso.com. + +### Example 5 +```powershell +Set-CsPhoneNumberAssignment -Identity cq1@contoso.com -PhoneNumber +14255551225 -PhoneNumberType DirectRouting +``` +This example assigns the Direct Routing phone number +1 (425) 555-1225 to the resource account cq1@contoso.com. + +### Example 6 +```powershell +Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting +``` +This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 to the user user4@contoso.com. + +### Example 7 +```powershell +Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occurred } +``` +This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. + +### Example 8 +```powershell +$TempUser = "tempuser@contoso.com" +$OldLoc=Get-CsOnlineLisLocation -City Vancouver +$NewLoc=Get-CsOnlineLisLocation -City Seattle +$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment +foreach ($No in $Numbers) { + Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId + Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber +} +``` +This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers, assigning each phone number temporarily with the new location to a user, and then unassigning the phone number again from the user. + +### Example 9 +```powershell +$loc=Get-CsOnlineLisLocation -City Toronto +Set-CsPhoneNumberAssignment -PhoneNumber +12065551224 -LocationId $loc.LocationId +``` +This example shows how to set the location on a phone number. + +### Example 10 +```powershell +$OldLocationId = "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" +$NewLocationId = "951fac72-955e-4734-ab74-cc4c0f761c0b" +# Get all phone numbers in old location +$pns = Get-CsPhoneNumberAssignment -LocationId $OldLocationId +Write-Host $pns.count numbers found in old location $OldLocationId +# Move all those phone numbers to the new location +foreach ($pn in $pns) { + Try { + Set-CsPhoneNumberAssignment -PhoneNumber $pn.TelephoneNumber -LocationId $NewLocationId -ErrorAction Stop + Write-Host $pn.TelephoneNumber was updated to have location $NewLocationId + } + Catch { + Write-Host Could not update $pn.TelephoneNumber with location $NewLocationId + } +} +Write-Host (Get-CsPhoneNumberAssignment -LocationId $OldLocationId).Count numbers found in old location $OldLocationId +Write-Host (Get-CsPhoneNumberAssignment -LocationId $NewLocationId).Count numbers found in new location $NewLocationId +``` +This Example shows how to update the LocationID from an old location to a new location for a set of phone numbers. + +### Example 11 +```powershell +Set-CsPhoneNumberAssignment -Identity user3@contoso.com -PhoneNumber +12065551226 -ReverseNumberLookup 'SkipInternalVoip' +``` +This example shows how to turn off reverse number lookup (RNL) on a phone number. When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. This example is only applicable for Direct Routing phone numbers. + +### Example 12 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -AssignmentCategory Private +``` +This example shows how to assign a private phone number (incoming calls only) to a user. + +### Example 13 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -LocationId "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" -Notify +``` +This example shows how to send an email to Teams phone users informing them about the new telephone number assignment. Note: For assignment of India telephone numbers provided by Airtel, Teams Phone users will automatically receive an email outlining the usage guidelines and restrictions. This notification is mandatory and cannot be opted out of. + +## PARAMETERS + +### -AssignmentCategory + +> Applicable: Microsoft Teams + +This parameter indicates the phone number assignment category if it isn't the primary phone number. For example, a Private line can be assigned to a user using '-AssignmentCategory Private'. + + +```yaml +Type: System.String +Parameter Sets: (Assignment) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseVoiceEnabled + +> Applicable: Microsoft Teams + +Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. + +This parameter is mutual exclusive with PhoneNumber. + +```yaml +Type: System.Boolean +Parameter Sets: (Attribute) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the specific user or resource account. Can be specified using the value in the ObjectId, the SipProxyAddress, or the UserPrincipalName attribute of the user or +resource account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationId +The LocationId of the location to assign to the specific user. You can get it using Get-CsOnlineLisLocation. You can set the location on both assigned and unassigned +phone numbers. + +Removal of location from a phone number is supported for Direct Routing numbers and Operator Connect numbers that are not managed by the Service Desk. +If you want to remove the location, use the string value null for LocationId. + +```yaml +Type: System.String +Parameter Sets: (Assignment, LocationUpdate) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteId + +> Applicable: Microsoft Teams + +ID of a network site. A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. + +```yaml +Type: System.String +Parameter Sets: (Assignment) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notify +Sends an email to Teams phone user about new telephone number assignment. + +```yaml +Type: Switch +Parameter Sets: (Assignment) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumber +The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can't have "tel:" prefixed. + +We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. + +Setting a phone number will automatically set EnterpriseVoiceEnabled to True. + +```yaml +Type: System.String +Parameter Sets: (Assignment, LocationUpdate) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhoneNumberType +The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. + +```yaml +Type: System.String +Parameter Sets: (Assignment) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseNumberLookup +This parameter is used to control the behavior of reverse number lookup (RNL) for a phone number.When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. + +```yaml +Type: String +Parameter Sets: (ReverseNumberLookupUpdate, Assignment) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 3.0.0 or later. The parameter set LocationUpdate was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The parameter set NetworkSiteUpdate was introduced in Teams PowerShell module 5.5.1-preview. + +The cmdlet is only available in commercial and GCC cloud instances. + +If a user or resource account has a phone number set in Active Directory on-premises and synched into Microsoft 365, you can't use Set-CsPhoneNumberAssignment to set the phone number. You will have to clear the phone number from the on-premises Active Directory and let that change sync into Microsoft 365 first. + +The previous command for assigning phone numbers to users Set-CsUser had the parameter HostedVoiceMail. Setting HostedVoiceMail for Microsoft Teams users is no longer +necessary and that is why the parameter is not available on Set-CsPhoneNumberAssignment. + +## RELATED LINKS +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) + +[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberTag.md similarity index 98% rename from teams/teams-ps/teams/Set-CsPhoneNumberTag.md rename to teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberTag.md index c571a93910..207ccac3fa 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberTag.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsPhoneNumberTag.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/set-csphonenumbertag applicable: Microsoft Teams -title: Set-CsPhoneNumberTag author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/teams/set-csphonenumbertag schema: 2.0.0 +title: Set-CsPhoneNumberTag --- # Set-CsPhoneNumberTag diff --git a/teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/MicrosoftTeams/Set-CsSharedCallQueueHistoryTemplate.md similarity index 93% rename from teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md rename to teams/teams-ps/MicrosoftTeams/Set-CsSharedCallQueueHistoryTemplate.md index 5cd82bcea2..4f2cc79d94 100644 --- a/teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsSharedCallQueueHistoryTemplate.md @@ -1,20 +1,24 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsSharedCallQueueHistoryTemplate applicable: Microsoft Teams -title: Set-CsSharedCallQueueHistoryTemplate -schema: 2.0.0 -manager: author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +title: Set-CsSharedCallQueueHistoryTemplate --- # Set-CsSharedCallQueueHistoryTemplate +## SYNOPSIS +Use the Set-CsSharedCallQueueHistoryTemplate cmdlet to change a Shared Call Queue History template + ## SYNTAX -```powershell +``` Set-CsSharedCallQueueHistoryTemplate -Instance [] ``` @@ -26,7 +30,7 @@ Use the Set-SharedCallQueueHistory cmdlet to change a Shared Call Queue History ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $SharedCQHistory = Get-CsSharedCallQueueHistory -Id 66f0dc32-d344-4bb1-b524-027d4635515c $SharedCQHisotry.AnsweredAndOutboundCalls = "AuthorizedUsersAndAgents" @@ -53,7 +57,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAIPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsAIPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAIPolicy.md index 2c43c43e51..c31f95bb55 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAIPolicy.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: Andy447 external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-CsTeamsAIPolicy +ms.author: andywang online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsAIPolicy schema: 2.0.0 -author: Andy447 -ms.author: andywang +title: Set-CsTeamsAIPolicy --- # Set-CsTeamsAIPolicy @@ -99,15 +100,15 @@ Set Teams AI policy "SpeakerAttributionBYOD" value to "Disabled" for identity "T ## PARAMETERS -### -Identity -Identity of the Teams AI policy. - +### -Description +Enables administrators to provide explanatory text about the Teams AI policy. +For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -144,32 +145,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpeakerAttributionBYOD -Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. +### -Identity +Identity of the Teams AI policy. ```yaml Type: String -Parameter Sets: ("Enabled","Disabled") +Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text about the Teams AI policy. -For example, the Description might indicate the users the policy should be assigned to. +### -SpeakerAttributionBYOD +Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. + ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: ("Enabled","Disabled") Aliases: -Required: False +Required: True Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAcsFederationConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAcsFederationConfiguration.md index dcc0f7acf6..941b64f8b3 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAcsFederationConfiguration.md @@ -1,11 +1,12 @@ --- +author: tomkau external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsAcsFederationConfiguration -author: tomkau ms.author: tomkau online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration schema: 2.0.0 +title: Set-CsTeamsAcsFederationConfiguration --- # Set-CsTeamsAcsFederationConfiguration @@ -58,18 +59,6 @@ Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowedAcsResources ## PARAMETERS -### -EnableAcsUsers - -Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. - -```yaml -Type: Boolean -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowAllAcsResources DEPRECATED. Do not use. @@ -82,9 +71,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockedAcsResources +### -AllowedAcsResources -List of blocked Azure Communication Services resources. +The list of the ACS resources (at least one) for which federation is enabled, when EnableAcsUsers is set to true. If EnableAcsUsers is set to false, then this list is ignored and should be null/empty. The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. @@ -96,9 +85,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedAcsResources +### -BlockedAcsResources -The list of the ACS resources (at least one) for which federation is enabled, when EnableAcsUsers is set to true. If EnableAcsUsers is set to false, then this list is ignored and should be null/empty. +List of blocked Azure Communication Services resources. The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. @@ -110,21 +99,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LabelForAllowedAcsUsers - -This configuration controls the user label that is displayed for Azure Communication Services users when they join Teams meetings or calls. Possible values are: Unverified, External. When the value is set to Unverified, the ACS user label is displayed as 'Unverified' when an ACS user joins Teams meetings or calls. When the value is set to External, if an ACS user joins a Teams meeting or call from a resource listed in AllowAllAcsResources, their label should be displayed as 'External'. - -```yaml -Type: String -Position: Named -Default value: Unverified -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireAcsFederationForMeeting +### -EnableAcsUsers -This configuration controls whether ACS Federation is required for meetings. Possibles values are: True, False. +Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. ```yaml Type: Boolean @@ -162,6 +139,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LabelForAllowedAcsUsers + +This configuration controls the user label that is displayed for Azure Communication Services users when they join Teams meetings or calls. Possible values are: Unverified, External. When the value is set to Unverified, the ACS user label is displayed as 'Unverified' when an ACS user joins Teams meetings or calls. When the value is set to External, if an ACS user joins a Teams meeting or call from a resource listed in AllowAllAcsResources, their label should be displayed as 'External'. + +```yaml +Type: String +Position: Named +Default value: Unverified +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireAcsFederationForMeeting + +This configuration controls whether ACS Federation is required for meetings. Possibles values are: True, False. + +```yaml +Type: Boolean +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy.md index 58ff1553f7..1f1bd74b3a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppPermissionPolicy.md @@ -1,21 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsapppermissionpolicy applicable: Microsoft Teams -title: Set-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: mhayrapetyan -manager: prkosh author: serdarsoysal +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: prkosh +Module Name: MicrosoftTeams ms.author: serdars +ms.reviewer: mhayrapetyan +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsapppermissionpolicy +schema: 2.0.0 +title: Set-CsTeamsAppPermissionPolicy --- # Set-CsTeamsAppPermissionPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. - -As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . +Cmdlet to set the app permission policy for Teams. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppSetupPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppSetupPolicy.md index 1e6e8b5c3a..6aeffeb88c 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAppSetupPolicy.md @@ -1,24 +1,22 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsappsetuppolicy -applicable: Microsoft Teams -title: Set-CsTeamsAppSetupPolicy schema: 2.0.0 +title: Set-CsTeamsAppSetupPolicy --- # Set-CsTeamsAppSetupPolicy ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Cmdlet to set the app setup policy for Teams. ## SYNTAX ### Identity (Default) -```powershell +``` Set-CsTeamsAppSetupPolicy [[-Identity] ] [-AllowSideLoading ] [-AllowUserPinning ] @@ -37,7 +35,7 @@ Set-CsTeamsAppSetupPolicy [[-Identity] ] ``` ### Instance -```powershell +``` Set-CsTeamsAppSetupPolicy [-Instance ] [-AllowSideLoading ] [-AllowUserPinning ] @@ -118,33 +116,18 @@ Step 3: Settings to install these apps in your users' personal Teams environment ## PARAMETERS -### -Identity -Name of app setup policy. If empty, all identities will be used by default. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Do not use. +### -AdditionalCustomizationApps +This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -193,21 +176,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdditionalCustomizationApps -This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. - -```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AppPresetMeetingList This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. @@ -268,6 +236,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Name of app setup policy. If empty, all identities will be used by default. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Do not use. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -PinnedAppBarApps Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that users need the most and promote ease of access. diff --git a/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy.md index aee67a3709..edcdbba023 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsAudioConferencingPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy -title: Set-CsTeamsAudioConferencingPolicy schema: 2.0.0 +title: Set-CsTeamsAudioConferencingPolicy --- # Set-CsTeamsAudioConferencingPolicy @@ -62,6 +63,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. @@ -123,21 +139,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallHoldPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallHoldPolicy.md index 27aaba2f36..e10773a41f 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallHoldPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy applicable: Microsoft Teams -title: Set-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +Locale: en-US manager: abnair +Module Name: MicrosoftTeams ms.author: serdars -author: serdarsoysal +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy +schema: 2.0.0 +title: Set-CsTeamsCallHoldPolicy --- # Set-CsTeamsCallHoldPolicy @@ -54,16 +55,31 @@ This policy is re-assigned the description from its existing value to "country m ## PARAMETERS -### -Identity -Unique identifier of the Teams call hold policy being modified. +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -86,11 +102,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFileId -A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -101,16 +117,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StreamingSourceUrl -This parameter is reserved for internal Microsoft use. +### -Identity +Unique identifier of the Teams call hold policy being modified. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -131,11 +147,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -162,21 +178,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallParkPolicy.md similarity index 87% rename from teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallParkPolicy.md index 14c75e129a..f7316ee211 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallParkPolicy.md @@ -1,22 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallparkpolicy applicable: Microsoft Teams -title: Set-CsTeamsCallParkPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallparkpolicy +schema: 2.0.0 +title: Set-CsTeamsCallParkPolicy --- # Set-CsTeamsCallParkPolicy ## SYNOPSIS - -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. - -NOTE: The call park feature is currently available in desktop, mobile, and web clients. Supported with TeamsOnly mode. +The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. ## SYNTAX @@ -39,7 +38,12 @@ Set-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [-I ``` ## DESCRIPTION -The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different phone. The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. +The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in +Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then +perform a number of actions on that call: transfer to another department, retrieve via the same +phone, or retrieve via a different phone. + +NOTE: The call park feature is currently available in desktop, mobile, and web clients. Supported with TeamsOnly mode. ## EXAMPLES @@ -96,6 +100,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +Description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Suppress all non-fatal errors @@ -141,19 +160,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -PickupRangeEnd -Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. - -Note: PickupRangeStart must be smaller than PickupRangeEnd. +### -MsftInternalProcessingMode +For Internal use only. ```yaml -Type: Integer +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 99 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -173,8 +190,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PickupRangeStart -Specify the minimum value that a rendered pickup code can take. Value can be from 10 to 9999. +### -PickupRangeEnd +Specify the maximum value that a rendered pickup code can take. Value can be from 10 to 9999. Note: PickupRangeStart must be smaller than PickupRangeEnd. @@ -185,47 +202,33 @@ Aliases: Required: False Position: Named -Default value: 10 +Default value: 99 Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -PickupRangeStart +Specify the minimum value that a rendered pickup code can take. Value can be from 10 to 9999. -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Note: PickupRangeStart must be smaller than PickupRangeEnd. ```yaml -Type: SwitchParameter +Type: Integer Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named -Default value: None +Default value: 10 Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the policy. +### -Tenant +Internal Microsoft use only. ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: @@ -236,13 +239,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsftInternalProcessingMode -For Internal use only. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallingPolicy.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallingPolicy.md index 1f3a0f0fe7..e2fa9b242e 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCallingPolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy applicable: Microsoft Teams -title: Set-CsTeamsCallingPolicy -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars ms.reviewer: alejandramu +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy +schema: 2.0.0 +title: Set-CsTeamsCallingPolicy --- # Set-CsTeamsCallingPolicy @@ -80,22 +81,10 @@ Sets the value of the parameter LiveCaptionsEnabledTypeForCalling to Disabled in ## PARAMETERS -### -Identity -Name of the policy instance being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -110,7 +99,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -120,13 +108,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToPhone + +> Applicable: Microsoft Teams + Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -136,13 +126,15 @@ Accept wildcard characters: False ``` ### -AllowCallForwardingToUser + +> Applicable: Microsoft Teams + Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -152,13 +144,15 @@ Accept wildcard characters: False ``` ### -AllowCallGroups + +> Applicable: Microsoft Teams + Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -168,6 +162,9 @@ Accept wildcard characters: False ``` ### -AllowCallRedirect + +> Applicable: Microsoft Teams + Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway. Valid options are: @@ -180,7 +177,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -190,13 +186,15 @@ Accept wildcard characters: False ``` ### -AllowCloudRecordingForCalls + +> Applicable: Microsoft Teams + Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -206,13 +204,15 @@ Accept wildcard characters: False ``` ### -AllowDelegation + +> Applicable: Microsoft Teams + Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -222,6 +222,9 @@ Accept wildcard characters: False ``` ### -AllowPrivateCalling + +> Applicable: Microsoft Teams + Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. @@ -229,7 +232,6 @@ If you use Skype for Business for calling, this policy will not affect calling f Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -239,13 +241,15 @@ Accept wildcard characters: False ``` ### -AllowSIPDevicesCalling + +> Applicable: Microsoft Teams + Determines whether the user is allowed to use a SIP device for calling on behalf of a Teams client. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -255,13 +259,15 @@ Accept wildcard characters: False ``` ### -AllowTranscriptionForCalling + +> Applicable: Microsoft Teams + Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -271,6 +277,9 @@ Accept wildcard characters: False ``` ### -AllowVoicemail + +> Applicable: Microsoft Teams + Enables inbound calls to be routed to voicemail. Valid options are: @@ -283,7 +292,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -293,13 +301,15 @@ Accept wildcard characters: False ``` ### -AllowWebPSTNCalling + +> Applicable: Microsoft Teams + Allows PSTN calling from the Teams web client. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -325,6 +335,9 @@ Accept wildcard characters: False ``` ### -BusyOnBusyEnabledType + +> Applicable: Microsoft Teams + Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. Valid options are: @@ -338,7 +351,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -348,6 +360,9 @@ Accept wildcard characters: False ``` ### -CallingSpendUserLimit + +> Applicable: Microsoft Teams + The maximum amount a user can spend on outgoing PSTN calls, including all calls made through Pay-as-you-go Calling Plans and any overages on plans with bundled minutes. Possible values: any positive integer @@ -356,7 +371,6 @@ Possible values: any positive integer Type: Long Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -366,13 +380,15 @@ Accept wildcard characters: False ``` ### -CallRecordingExpirationDays + +> Applicable: Microsoft Teams + Sets the expiration of the recorded 1:1 calls. Default is 60 days. ```yaml Type: Long Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -382,13 +398,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -398,6 +416,9 @@ Accept wildcard characters: False ``` ### -Copilot + +> Applicable: Microsoft Teams + Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call. Valid options are: @@ -409,7 +430,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -419,13 +439,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users to whom the policy should be assigned. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -435,6 +457,9 @@ Accept wildcard characters: False ``` ### -EnableSpendLimits + +> Applicable: Microsoft Teams + This setting allows an admin to enable or disable spend limits on PSTN calls for their user base. Possible values: @@ -446,7 +471,6 @@ Possible values: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -472,13 +496,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Microsoft Teams + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named @@ -487,7 +513,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Name of the policy instance being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InboundFederatedCallRoutingTreatment + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound federated calls should be routed. Valid options are: @@ -502,7 +546,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -512,6 +555,9 @@ Accept wildcard characters: False ``` ### -InboundPstnCallRoutingTreatment + +> Applicable: Microsoft Teams + Setting this parameter lets you control how inbound PSTN calls should be routed. Valid options are: @@ -527,7 +573,6 @@ Setting this parameter to Unanswered or Voicemail will have precedence over othe Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -537,6 +582,9 @@ Accept wildcard characters: False ``` ### -LiveCaptionsEnabledTypeForCalling + +> Applicable: Microsoft Teams + Determines whether real-time captions are available for the user in Teams calls. Valid options are: @@ -548,7 +596,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -558,6 +605,9 @@ Accept wildcard characters: False ``` ### -MusicOnHoldEnabledType + +> Applicable: Microsoft Teams + Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold. Valid options are: @@ -570,7 +620,6 @@ Valid options are: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -580,13 +629,15 @@ Accept wildcard characters: False ``` ### -PopoutAppPathForIncomingPstnCalls + +> Applicable: Microsoft Teams + Setting this parameter allows you to set the PopoutForIncomingPstnCalls setting's URL path of the website to launch upon receiving incoming PSTN calls. This parameter accepts an HTTPS URL with less than 1024 characters. The URL can contain a `{phone}` placeholder that is replaced with the caller's PSTN number in E.164 format when launched. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: "" @@ -595,13 +646,15 @@ Accept wildcard characters: False ``` ### -PopoutForIncomingPstnCalls + +> Applicable: Microsoft Teams + Setting this parameter allows you to control the tenant users' ability to launch an external website URL automatically in the browser window upon incoming PSTN calls for specific users or user groups. Valid options are Enabled and Disabled. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: Disabled @@ -610,6 +663,9 @@ Accept wildcard characters: False ``` ### -PreventTollBypass + +> Applicable: Microsoft Teams + Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. > [!NOTE] @@ -619,7 +675,6 @@ Setting this parameter to True will send calls through PSTN and incur charges ra Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -628,76 +683,84 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpamFilteringEnabledType -Determines if spam detection is enabled for inbound PSTN calls. +### -RealTimeText -Possible values: +> Applicable: Microsoft Teams -- Enabled: Spam detection is enabled. In case the inbound call is considered spam, the user will get a "Spam Likely" label in Teams. -- Disabled: Spam detection is disabled. +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceSimulationInInterpreter +### -SpamFilteringEnabledType -> [!NOTE] -> This feature has not been released yet and will have no changes if it is enabled or disabled. +> Applicable: Microsoft Teams -Enables the user to use the voice simulation feature while being AI interpreted. +Determines if spam detection is enabled for inbound PSTN calls. -Possible Values: +Possible values: -- Disabled -- Enabled +- Enabled: Spam detection is enabled. In case the inbound call is considered spam, the user will get a "Spam Likely" label in Teams. +- Disabled: Spam detection is disabled. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeText ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. +### -VoiceSimulationInInterpreter -Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. +> Applicable: Microsoft Teams + +> [!NOTE] +> This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the voice simulation feature while being AI interpreted. Possible Values: -- Enabled: User is allowed to turn on real time text. -- Disabled: User is not allowed to turn on real time text. + +- Disabled +- Enabled ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: Enabled +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -705,7 +768,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsChannelsPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsChannelsPolicy.md index a6e29ca6ed..9b1c7976cc 100644 --- a/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsChannelsPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamschannelspolicy applicable: Microsoft Teams -title: Set-CsTeamsChannelsPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamschannelspolicy +schema: 2.0.0 +title: Set-CsTeamsChannelsPolicy --- # Set-CsTeamsChannelsPolicy @@ -50,14 +52,13 @@ This example shows updating an existing policy with name "StudentPolicy" and ena ## PARAMETERS -### -EnablePrivateTeamDiscovery -Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. +### -AllowChannelSharingToExternalUser +Owners of a shared channel can invite external users to join the channel if Microsoft Entra external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -65,13 +66,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowOrgWideTeamCreation +Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -80,11 +81,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Bypass all non-fatal errors. +### -AllowPrivateChannelCreation +Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -95,44 +96,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Use this parameter to specify the name of the policy being updated. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Use this parameter to pass the policy object output of Get-CsTeamsChannelsPolicy to update that policy. +### -AllowSharedChannelCreation +Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: Boolean +Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use only. +### -AllowUserToParticipateInExternalSharedChannel +Users and teams can be invited to external shared channels if Microsoft Entra external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml -Type: System.Guid +Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -140,13 +124,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -155,8 +139,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOrgWideTeamCreation -Determines whether a user is allowed to create an org-wide team. Set this to TRUE to allow. Set this FALSE to prohibit. +### -EnablePrivateTeamDiscovery +Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml Type: Boolean @@ -170,11 +154,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateChannelCreation -Determines whether a user is allowed to create a private channel. Set this to TRUE to allow. Set this FALSE to prohibit. +### -Force +Bypass all non-fatal errors. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -185,41 +169,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelSharingToExternalUser -Owners of a shared channel can invite external users to join the channel if Microsoft Entra external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). +### -Identity +Use this parameter to specify the name of the policy being updated. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: + Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedChannelCreation -Team owners can create shared channels for people within and outside the organization. Only people added to the shared channel can read and write messages. +### -Instance +Use this parameter to pass the policy object output of Get-CsTeamsChannelsPolicy to update that policy. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: + Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -AllowUserToParticipateInExternalSharedChannel -Users and teams can be invited to external shared channels if Microsoft Entra external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). +### -Tenant +Internal Microsoft use only. ```yaml -Type: Boolean +Type: System.Guid Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -246,6 +233,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsClientConfiguration.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsClientConfiguration.md index d2685ba41e..be0ba7838e 100644 --- a/teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsClientConfiguration.md @@ -1,20 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsclientconfiguration applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Set-CsTeamsClientConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsclientconfiguration +schema: 2.0.0 +title: Set-CsTeamsClientConfiguration --- # Set-CsTeamsClientConfiguration ## SYNOPSIS -The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and how Surface Hub devices can interact with Skype for Business meetings. The parameter descriptions below describe what settings are managed by this configuration and how they are enforced. +Changes the Teams client configuration settings for the specified tenant. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication.md index 1e7e7f36f9..dc62f2a628 100644 --- a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication applicable: Microsoft Teams -title: Set-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication +schema: 2.0.0 +title: Set-CsTeamsComplianceRecordingApplication --- # Set-CsTeamsComplianceRecordingApplication @@ -115,105 +116,158 @@ Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredD ## PARAMETERS -### -Identity -A name that uniquely identifies the application instance of the policy-based recording application. +### -ComplianceRecordingPairedApplications +Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. -Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -To do this association correctly, the Identity of these application instances must be \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. +In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: ComplianceRecordingPairedApplication[] +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -ConcurrentInvitationCount +Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. + +In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: UInt32 +Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: True (ByValue) +Default value: 1 +Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredBeforeMeetingJoin -Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. +### -Confirm +Prompts you for confirmation before running the cmdlet. -If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. -The meeting will still continue for users who are in the meeting. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredDuringMeeting -Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. - -If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. -The meeting will still continue for users who are in the meeting. +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. -If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +To do this association correctly, the Identity of these application instances must be \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named -Default value: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredBeforeCallEstablishment -Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: -If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Priority +This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet. + +All policy-based recording applications are invited in parallel to ensure low call setup and meeting join latencies. +So this parameter does not affect the order of invitations to the applications, or any other routing. ```yaml -Type: Boolean +Type: Int32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiredDuringCall -Indicates whether the policy-based recording application must be in the call while the call is active. +### -RequiredBeforeCallEstablishment +Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. -If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. +If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. -If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. +If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. ```yaml Type: Boolean @@ -227,84 +281,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentInvitationCount -Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. - -In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. +### -RequiredBeforeMeetingJoin +Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. +If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. +The meeting will still continue for users who are in the meeting. -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. +If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 1 +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingPairedApplications -Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. - -In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. +### -RequiredDuringCall +Indicates whether the policy-based recording application must be in the call while the call is active. -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. +If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. +If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. ```yaml -Type: ComplianceRecordingPairedApplication[] +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet. +### -RequiredDuringMeeting +Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. -All policy-based recording applications are invited in parallel to ensure low call setup and meeting join latencies. -So this parameter does not affect the order of invitations to the applications, or any other routing. +If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` @@ -335,36 +366,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy.md index 482a4c801b..6a7b59291d 100644 --- a/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsComplianceRecordingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy applicable: Microsoft Teams -title: Set-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar author: aditdalvi +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nakumar +Module Name: MicrosoftTeams ms.author: aditd -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy +schema: 2.0.0 +title: Set-CsTeamsComplianceRecordingPolicy --- # Set-CsTeamsComplianceRecordingPolicy @@ -96,43 +97,44 @@ This effectively stops automatic policy-based recording for all new calls and me ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new Teams recording policy. +### -ComplianceRecordingApplications +A list of application instances of policy-based recording applications to assign to this policy. +The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. -Use the "Global" Identity if you wish to assign this policy to the entire tenant. +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: ComplianceRecordingApplication[] +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### CustomBanner -References the Custom Banner text in the storage. +### -Description +Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: @@ -143,12 +145,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Controls whether this Teams recording policy is active or not. +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording -Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: -Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. ```yaml Type: Boolean @@ -162,8 +175,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WarnUserOnRemoval -This parameter is reserved for future use. +### -Enabled +Controls whether this Teams recording policy is active or not. + +Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. ```yaml Type: Boolean @@ -172,16 +189,16 @@ Aliases: Required: False Position: Named -Default value: True +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -192,50 +209,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComplianceRecordingApplications -A list of application instances of policy-based recording applications to assign to this policy. -The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. +### -Identity +Unique identifier to be assigned to the new Teams recording policy. -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +Use the "Global" Identity if you wish to assign this policy to the entire tenant. ```yaml -Type: ComplianceRecordingApplication[] -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableComplianceRecordingAudioNotificationForCalls -Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -DisableComplianceRecordingAudioNotificationForCalls -Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. +### CustomBanner +References the Custom Banner text in the storage. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -281,32 +297,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -WarnUserOnRemoval +This parameter is reserved for future use. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCortanaPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCortanaPolicy.md index 15607b6980..e75e4a5839 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCortanaPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy applicable: Microsoft Teams -title: Set-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: amehta +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +schema: 2.0.0 +title: Set-CsTeamsCortanaPolicy --- # Set-CsTeamsCortanaPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCustomBannerText.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsCustomBannerText.md index 131dd52c2a..4366c26cb2 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsCustomBannerText.md @@ -1,10 +1,11 @@ --- +author: saleens7 +Locale: en-US Module Name: MicrosoftTeams +ms.author: wblocker online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText -title: Set-CsTeamsCustomBannerText schema: 2.0.0 -author: saleens7 -ms.author: wblocker +title: Set-CsTeamsCustomBannerText --- # Set-CsTeamsCustomBannerText @@ -27,6 +28,8 @@ Updates a single instance of custom banner text. ## EXAMPLES ### Example 1 + +``` PS C:\> Set-CsTeamsCustomBannerText -Id 123e4567-e89b-12d3-a456-426614174000 -Description "Custom Banner Text Example" -Text "Custom Text" ``` @@ -34,14 +37,27 @@ This example sets the properties of the CustomText instance of TeamsCustomBanner ## PARAMETERS +### -Description +The description that you would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id + +> Applicable: Microsoft Teams + The Identity of the CustomBannerText. ```yaml Type: Guid Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -60,17 +76,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -The description that you would like to set to identify what this text represents. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy.md index 3306c4828f..5e75d3b990 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationAssignmentsAppPolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseducationassignmentsapppolicy applicable: Microsoft Teams -title: Set-CsTeamsEducationAssignmentsAppPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseducationassignmentsapppolicy +schema: 2.0.0 +title: Set-CsTeamsEducationAssignmentsAppPolicy --- # Set-CsTeamsEducationAssignmentsAppPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationConfiguration.md index 2574fce8c8..48ffe8688a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEducationConfiguration.md @@ -1,11 +1,12 @@ --- +author: SaritaBehera external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsEducationConfiguration -author: SaritaBehera ms.author: saritabehera online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration schema: 2.0.0 +title: Set-CsTeamsEducationConfiguration --- # Set-CsTeamsEdcuationConfiguration diff --git a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy.md index f17f6774c5..29aeb31064 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy applicable: Microsoft Teams -title: Set-CsTeamsEmergencyCallRoutingPolicy author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy schema: 2.0.0 +title: Set-CsTeamsEmergencyCallRoutingPolicy --- # Set-CsTeamsEmergencyCallRoutingPolicy @@ -68,6 +70,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Provides a description of the Teams Emergency Call Routing policy to identify the purpose of setting it. @@ -128,21 +145,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy.md index b67d6b3cd5..1b6900fb82 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEmergencyCallingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy applicable: Microsoft Teams -title: Set-CsTeamsEmergencyCallingPolicy author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars ms.reviewer: chenc +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy schema: 2.0.0 +title: Set-CsTeamsEmergencyCallingPolicy --- # Set-CsTeamsEmergencyCallingPolicy @@ -55,6 +57,21 @@ This example first creates two new Teams Emergency Calling Extended Notification ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Provides a description of the Teams Emergency Calling policy to identify the purpose of setting it. @@ -196,21 +213,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEnhancedEncryptionPolicy.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEnhancedEncryptionPolicy.md index 33b326f662..9b7f91f024 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEnhancedEncryptionPolicy.md @@ -1,209 +1,210 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy -title: Set-CsTeamsEnhancedEncryptionPolicy -author: serdarsoysal -ms.author: serdars -manager: mdress -schema: 2.0.0 ---- - -# Set-CsTeamsEnhancedEncryptionPolicy - -## SYNOPSIS -Use this cmdlet to update values in existing Teams enhanced encryption policy. - -## SYNTAX - -``` -Set-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] - [[-Identity] ] [-Force] [-Instance ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Use this cmdlet to update values in existing Teams enhanced encryption policy. - -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - -## EXAMPLES - -### EXAMPLE 1 -```PowerShell -PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -``` - -The command shown in Example 1 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - -This policy is re-assigned CallingEndtoEndEncryptionEnabledType to be DisabledUserOverride. - -Any Microsoft Teams users who are assigned this policy will have their enhanced encryption policy customized such that the user can use the enhanced encryption setting in Teams. - -### EXAMPLE 2 -```PowerShell -PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -MeetingEndToEndEncryption DisabledUserOverride -``` - -The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - -This policy has re-assigned MeetingEndToEndEncryption to be DisabledUserOverride. - -Any Microsoft Teams users who are assigned this policy and have a Teams Premium license will have the option to create end-to-end encrypted meetings. [Learn more about end-to-end encryption for Teams meetings](https://support.microsoft.com/en-us/office/use-end-to-end-encryption-for-teams-meetings-a8326d15-d187-49c4-ac99-14c17dbd617c). - -### EXAMPLE 3 -```PowerShell -PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" -``` - -The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - -This policy is re-assigned the description from its existing value to "allow useroverride". - -## PARAMETERS - -### -Description -Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. - -For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallingEndtoEndEncryptionEnabledType -Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingEndToEndEncryption -Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams enhanced encryption policy. - -Use the "Global" Identity if you wish modify the policy set for the entire tenant. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses all non-fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Use this to pipe a specific enhanced encryption policy to be set. You can only modify the global policy, so can only pass the global instance of the enhanced encryption policy. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) - -[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) - -[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) - -[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) +--- +author: serdarsoysal +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: mdress +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy +schema: 2.0.0 +title: Set-CsTeamsEnhancedEncryptionPolicy +--- + +# Set-CsTeamsEnhancedEncryptionPolicy + +## SYNOPSIS +Use this cmdlet to update values in existing Teams enhanced encryption policy. + +## SYNTAX + +``` +Set-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] + [[-Identity] ] [-Force] [-Instance ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Use this cmdlet to update values in existing Teams enhanced encryption policy. + +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. + +## EXAMPLES + +### EXAMPLE 1 +```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -CallingEndtoEndEncryptionEnabledType DisabledUserOverride +``` + +The command shown in Example 1 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + +This policy is re-assigned CallingEndtoEndEncryptionEnabledType to be DisabledUserOverride. + +Any Microsoft Teams users who are assigned this policy will have their enhanced encryption policy customized such that the user can use the enhanced encryption setting in Teams. + +### EXAMPLE 2 +```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -MeetingEndToEndEncryption DisabledUserOverride +``` + +The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + +This policy has re-assigned MeetingEndToEndEncryption to be DisabledUserOverride. + +Any Microsoft Teams users who are assigned this policy and have a Teams Premium license will have the option to create end-to-end encrypted meetings. [Learn more about end-to-end encryption for Teams meetings](https://support.microsoft.com/en-us/office/use-end-to-end-encryption-for-teams-meetings-a8326d15-d187-49c4-ac99-14c17dbd617c). + +### EXAMPLE 3 +```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" +``` + +The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. + +This policy is re-assigned the description from its existing value to "allow useroverride". + +## PARAMETERS + +### -CallingEndtoEndEncryptionEnabledType +Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. + +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams enhanced encryption policy. + +Use the "Global" Identity if you wish modify the policy set for the entire tenant. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Use this to pipe a specific enhanced encryption policy to be set. You can only modify the global policy, so can only pass the global instance of the enhanced encryption policy. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MeetingEndToEndEncryption +Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) + +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) + +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) + +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEventsPolicy.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsEventsPolicy.md index eb143c568f..c663dde17d 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsEventsPolicy.md @@ -1,470 +1,471 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseventspolicy -title: Set-CsTeamsEventsPolicy -schema: 2.0.0 -ms.date: 04/23/2025 ---- - -# Set-CsTeamsEventsPolicy - -## SYNOPSIS -This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. - -## SYNTAX - -``` -Set-CsTeamsEventsPolicy [-AllowWebinars ] [-EventAccessType ] [-AllowTownhalls ] [-ImmersiveEvents ] - [-TownhallEventAttendeeAccess ] [-AllowEmailEditing ] [-AllowedQuestionTypesInRegistrationForm ] - [-AllowEventIntegrations ] [-AllowedWebinarTypesForRecordingPublish ] - [-AllowedTownhallTypesForRecordingPublish ] [-TownhallChatExperience ] [-Description ] - [-RecordingForTownhall ] [-RecordingForWebinar ] - [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] - [-UseMicrosoftECDN ] [-BroadcastPremiumApps ] -``` - -## DESCRIPTION -User-level policy for tenant admin to configure options for customizing Teams events experiences. Use this cmdlet to update an existing policy. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled -``` - -The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. - -## PARAMETERS - -### -AllowWebinars -This setting governs if a user can create webinars using Teams Events. -Possible values are: - - **Enabled**: Enables creating webinars. - - **Disabled**: Disables creating webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseMicrosoftECDN -This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTownhalls -This setting governs if a user can create town halls using Teams Events. -Possible values are: - - **Enabled**: Enables creating town halls. - - **Disabled**: Disables creating town halls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImmersiveEvents -This setting governs if a user can create Immersive Events using Teams Events. -Possible values are: - - **Enabled**: Enables creating Immersive Events. - - **Disabled**: Disables creating Immersive Events. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TownhallEventAttendeeAccess -This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. -Possible values are: - - **Everyone**: Anyone with the join link may enter the event. - - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Everyone -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEmailEditing -This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. -Possible values are: - - **Enabled**: Enables editing of communication emails. - - **Disabled**: Disables editing of communication emails. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch does not work with this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventAccessType - -> [!NOTE] -> Currently, webinar and town hall event access is managed together via EventAccessType. - -This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. -Possible values are: - - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - - **EveryoneInCompanyExcludingGuests**: Enables creating events to allow only in-tenant users to register and join the event. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams Events policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedQuestionTypesInRegistrationForm -This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. - -Possible values are: -DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedTownhallTypesForRecordingPublish -This setting describes how IT admins can control which types of Town Hall attendees can have their recordings published. - -Possible values are: -None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedWebinarTypesForRecordingPublish -This setting describes how IT admins can control which types of webinar attendees can have their recordings published. - -Possible values are: -None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEventIntegrations -This setting governs access to the integrations tab in the event creation workflow. - -Possible values -true, false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TownhallChatExperience -This setting governs whether the user can enable the Comment Stream chat experience for Town Halls. - -Possible values are: Optimized, None. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordingForTownhall -Determines whether recording is allowed in a user's townhall. - -Possible values are: - - **Enabled**: Allow recording in user's townhalls. - - **Disabled**: Prohibit recording in user's townhalls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordingForWebinar -Determines whether recording is allowed in a user's webinar. - -Possible values are: - - **Enabled**: Allow recording in user's webinars. - - **Disabled**: Prohibit recording in user's webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TranscriptionForTownhall -Determines whether transcriptions are allowed in a user's townhall. - -Possible values are: - - **Enabled**: Allow transcriptions in user's townhalls. - - **Disabled**: Prohibit transcriptions in user's townhalls. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TranscriptionForWebinar -Determines whether transcriptions are allowed in a user's webinar. - -Possible values are: - - **Enabled**: Allow transcriptions in user's webinars. - - **Disabled**: Prohibit transcriptions in user's webinars. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BroadcastPremiumApps -This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. - -Possible values are: -- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall -- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch does not work with this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch does not work with this cmdlet. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.date: 04/23/2025 +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseventspolicy +schema: 2.0.0 +title: Set-CsTeamsEventsPolicy +--- + +# Set-CsTeamsEventsPolicy + +## SYNOPSIS +This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. + +## SYNTAX + +``` +Set-CsTeamsEventsPolicy [-AllowWebinars ] [-EventAccessType ] [-AllowTownhalls ] [-ImmersiveEvents ] + [-TownhallEventAttendeeAccess ] [-AllowEmailEditing ] [-AllowedQuestionTypesInRegistrationForm ] + [-AllowEventIntegrations ] [-AllowedWebinarTypesForRecordingPublish ] + [-AllowedTownhallTypesForRecordingPublish ] [-TownhallChatExperience ] [-Description ] + [-RecordingForTownhall ] [-RecordingForWebinar ] + [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] + [-UseMicrosoftECDN ] [-BroadcastPremiumApps ] +``` + +## DESCRIPTION +User-level policy for tenant admin to configure options for customizing Teams events experiences. Use this cmdlet to update an existing policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled +``` + +The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. + +## PARAMETERS + +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. + +Possible values are: +DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTownhallTypesForRecordingPublish +This setting describes how IT admins can control which types of Town Hall attendees can have their recordings published. + +Possible values are: +None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedWebinarTypesForRecordingPublish +This setting describes how IT admins can control which types of webinar attendees can have their recordings published. + +Possible values are: +None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailEditing +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. +Possible values are: + - **Enabled**: Enables editing of communication emails. + - **Disabled**: Disables editing of communication emails. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEventIntegrations +This setting governs access to the integrations tab in the event creation workflow. + +Possible values +true, false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTownhalls +This setting governs if a user can create town halls using Teams Events. +Possible values are: + - **Enabled**: Enables creating town halls. + - **Disabled**: Disables creating town halls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWebinars +This setting governs if a user can create webinars using Teams Events. +Possible values are: + - **Enabled**: Enables creating webinars. + - **Disabled**: Disables creating webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastPremiumApps +This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. + +Possible values are: +- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall +- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventAccessType + +> [!NOTE] +> Currently, webinar and town hall event access is managed together via EventAccessType. + +This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. +Possible values are: + - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + - **EveryoneInCompanyExcludingGuests**: Enables creating events to allow only in-tenant users to register and join the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImmersiveEvents +This setting governs if a user can create Immersive Events using Teams Events. +Possible values are: + - **Enabled**: Enables creating Immersive Events. + - **Disabled**: Disables creating Immersive Events. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForTownhall +Determines whether recording is allowed in a user's townhall. + +Possible values are: + - **Enabled**: Allow recording in user's townhalls. + - **Disabled**: Prohibit recording in user's townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForWebinar +Determines whether recording is allowed in a user's webinar. + +Possible values are: + - **Enabled**: Allow recording in user's webinars. + - **Disabled**: Prohibit recording in user's webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallChatExperience +This setting governs whether the user can enable the Comment Stream chat experience for Town Halls. + +Possible values are: Optimized, None. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallEventAttendeeAccess +This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. +Possible values are: + - **Everyone**: Anyone with the join link may enter the event. + - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranscriptionForTownhall +Determines whether transcriptions are allowed in a user's townhall. + +Possible values are: + - **Enabled**: Allow transcriptions in user's townhalls. + - **Disabled**: Prohibit transcriptions in user's townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranscriptionForWebinar +Determines whether transcriptions are allowed in a user's webinar. + +Possible values are: + - **Enabled**: Allow transcriptions in user's webinars. + - **Disabled**: Prohibit transcriptions in user's webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMicrosoftECDN +This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch does not work with this cmdlet. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsExternalAccessConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsExternalAccessConfiguration.md index 3538e2a0af..8e5d27afca 100644 --- a/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsExternalAccessConfiguration.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsexternalaccessconfiguration -title: Set-CsTeamsExternalAccessConfiguration schema: 2.0.0 +title: Set-CsTeamsExternalAccessConfiguration --- # Set-CsTeamsExternalAccessConfiguration @@ -38,32 +39,32 @@ In this example, the admin has added two malicious users into the blocked list. ## PARAMETERS -### -BlockExternalAccessUserAccess -Designates whether BlockedUsers list is taking effect or not. $true means BlockedUsers are blocked and can't communicate with internal users. +### -BlockedUsers +You can specify blocked users using a List object that contains either the user email or the MRI from the external user you want to block. The user in the list will not able to communicate with the internal users in your organization. ```yaml -Type: Boolean +Type: List Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockedUsers -You can specify blocked users using a List object that contains either the user email or the MRI from the external user you want to block. The user in the list will not able to communicate with the internal users in your organization. +### -BlockExternalAccessUserAccess +Designates whether BlockedUsers list is taking effect or not. $true means BlockedUsers are blocked and can't communicate with internal users. ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFeedbackPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsFeedbackPolicy.md index c6a1f2b39c..0ce6043fd7 100644 --- a/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFeedbackPolicy.md @@ -1,9 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsfeedbackpolicy -applicable: Microsoft Teams -title: Set-CsTeamsFeedbackPolicy schema: 2.0.0 +title: Set-CsTeamsFeedbackPolicy --- # Set-CsTeamsFeedbackPolicy @@ -44,28 +46,28 @@ In this example, the policy "New Hire Feedback Policy" is modified, sets the use ## PARAMETERS -### -Identity -The unique identifier of the policy. +### -AllowEmailCollection +Set this to TRUE to enable Email collection. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowLogCollection +Set this to TRUE to enable log collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -74,11 +76,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. +### -AllowScreenshotCollection +Set this to TRUE to enable Screenshot collection. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -89,13 +91,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Internal Microsoft use. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -104,32 +106,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiveSurveysMode -Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. -Set it to EnabledUserOverride to have users receive the survey and allow them to opt out. - -Possible values: - - Enabled - - Disabled - - EnabledUserOverride +### -EnableFeatureSuggestions +This setting will enable Tenant Admins to hide or show the Teams menu item "Help | Suggest a Feature". +Possible Values: True, False ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -140,13 +137,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserInitiatedMode - Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. - Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. - -Possible values: - - Enabled - - Disabled +### -Identity +The unique identifier of the policy. ```yaml Type: String @@ -154,17 +146,17 @@ Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: Enabled +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEmailCollection -Set this to TRUE to enable Email collection. +### -Instance +Internal Microsoft use. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: @@ -175,26 +167,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowLogCollection -Set this to TRUE to enable log collection. +### -ReceiveSurveysMode +Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. +Set it to EnabledUserOverride to have users receive the survey and allow them to opt out. + +Possible values: + - Enabled + - Disabled + - EnabledUserOverride ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowScreenshotCollection -Set this to TRUE to enable Screenshot collection. +### -Tenant +Internal Microsoft use. ```yaml -Type: Boolean +Type: Object Parameter Sets: (All) Aliases: @@ -205,18 +203,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFeatureSuggestions -This setting will enable Tenant Admins to hide or show the Teams menu item "Help | Suggest a Feature". -Possible Values: True, False +### -UserInitiatedMode + Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. + Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. + +Possible values: + - Enabled + - Disabled ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFilesPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsFilesPolicy.md index 6f9a8796be..7ad0f67dd8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsFilesPolicy.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy -title: Set-CsTeamsFilesPolicy schema: 2.0.0 +title: Set-CsTeamsFilesPolicy --- # Set-CsTeamsFilesPolicy @@ -44,36 +45,37 @@ The command shown in Example 2 changes the DefaultFileUploadAppId to AppId_GUID ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -AutoShareFilesInExternalChats + +Indicates if file scope will be changed automatically when sharing files and loops in chats with external or guest users. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NativeFileEntryPoints -This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . -Possible values are Enabled or Disabled. +### -Confirm +Prompts you for confirmation before executing the command. + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False - ``` + ### -DefaultFileUploadAppId This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. @@ -89,28 +91,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -119,26 +123,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force - -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -FileSharingInChatswithExternalUsers - -Indicates if file sharing in chats with external users is enabled. - +### -NativeFileEntryPoints +This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . +Possible values are Enabled or Disabled. ```yaml Type: String Parameter Sets: (All) @@ -149,11 +151,11 @@ Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -``` -### -AutoShareFilesInExternalChats +``` +### -SPChannelFilesTab -Indicates if file scope will be changed automatically when sharing files and loops in chats with external or guest users. +Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. ```yaml Type: String @@ -167,18 +169,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPChannelFilesTab - -Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration.md index f79231986e..36d71d9149 100644 --- a/teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestCallingConfiguration.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestcallingconfiguration applicable: Microsoft Teams -title: Set-CsTeamsGuestCallingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestcallingconfiguration +schema: 2.0.0 +title: Set-CsTeamsGuestCallingConfiguration --- # Set-CsTeamsGuestCallingConfiguration diff --git a/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration.md index 1c4ee27ee2..bb577bbbce 100644 --- a/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMeetingConfiguration.md @@ -1,10 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestmeetingconfiguration -applicable: Microsoft Teams -title: Set-CsTeamsGuestMeetingConfiguration schema: 2.0.0 +title: Set-CsTeamsGuestMeetingConfiguration --- # Set-CsTeamsGuestMeetingConfiguration @@ -74,6 +75,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowTranscription +Determines whether post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -195,21 +211,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTranscription -Determines whether post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration.md index 41682046d1..5de3e0ad5e 100644 --- a/teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsGuestMessagingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestmessagingconfiguration applicable: Microsoft Teams -title: Set-CsTeamsGuestMessagingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestmessagingconfiguration +schema: 2.0.0 +title: Set-CsTeamsGuestMessagingConfiguration --- # Set-CsTeamsGuestMessagingConfiguration @@ -62,6 +64,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowImmersiveReader +Determines if immersive reader for viewing messages is enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowMemes Determines if memes are available for use. @@ -107,8 +124,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserDeleteMessage -Determines if a user is allowed to delete their own messages. +### -AllowUserDeleteChat +Turn this setting on to allow users to permanently delete their one-on-one chat, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. ```yaml Type: Boolean @@ -117,13 +134,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: TRUE Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserEditMessage -Determines if a user is allowed to edit their own messages. +### -AllowUserDeleteMessage +Determines if a user is allowed to delete their own messages. ```yaml Type: Boolean @@ -137,8 +154,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UsersCanDeleteBotMessages -Determines whether a user is allowed to delete messages sent by bots. Set this to TRUE to allow. Set this to FALSE to prohibit. +### -AllowUserEditMessage +Determines if a user is allowed to edit their own messages. ```yaml Type: Boolean @@ -147,7 +164,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -181,21 +198,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserDeleteChat -Turn this setting on to allow users to permanently delete their one-on-one chat, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: TRUE -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -GiphyRatingType Determines Giphy content restrictions. Default value is "Moderate", other options are "NoRestriction" and "Strict" @@ -211,39 +213,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowImmersiveReader -Determines if immersive reader for viewing messages is enabled. +### -Identity ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity +### -Instance ```yaml -Type: XdsIdentity +Type: PSObject Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance +### -Tenant ```yaml -Type: PSObject +Type: Guid Parameter Sets: (All) Aliases: @@ -254,16 +255,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -UsersCanDeleteBotMessages +Determines whether a user is allowed to delete messages sent by bots. Set this to TRUE to allow. Set this to FALSE to prohibit. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsIPPhonePolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsIPPhonePolicy.md index 0f608fbf29..17299b99c5 100644 --- a/teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsIPPhonePolicy.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsipphonepolicy applicable: Microsoft Teams -title: Set-CsTeamsIPPhonePolicy author: tonywoodruff +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: sandrao +Module Name: MicrosoftTeams ms.author: anwoodru ms.reviewer: kponnus -manager: sandrao +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsipphonepolicy schema: 2.0.0 +title: Set-CsTeamsIPPhonePolicy --- # Set-CsTeamsIPPhonePolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMediaConnectivityPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMediaConnectivityPolicy.md index 7bb81a371f..08be144935 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMediaConnectivityPolicy.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: lirunping-MSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-CsTeamsMediaConnectivityPolicy +ms.author: runli online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMediaConnectivityPolicy schema: 2.0.0 -author: lirunping-MSFT -ms.author: runli +title: Set-CsTeamsMediaConnectivityPolicy --- # Set-CsTeamsMediaConnectivityPolicy @@ -41,32 +42,32 @@ Set Teams media connectivity policy "DirectConnection" value to "Disabled" for i ## PARAMETERS -### -Identity -Identity of the Teams media connectivity policy. +### -DirectConnection +Policy value of the Teams media connectivity DirectConnection policy. ```yaml -Type: String -Parameter Sets: (All) +Type: Boolean +Parameter Sets: ("Enabled","Disabled") Aliases: Required: True Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -DirectConnection -Policy value of the Teams media connectivity DirectConnection policy. +### -Identity +Identity of the Teams media connectivity policy. ```yaml -Type: Boolean -Parameter Sets: ("Enabled","Disabled") +Type: String +Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -88,4 +89,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) -[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) \ No newline at end of file +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy.md index 033a024718..60676c0d64 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBrandingPolicy.md @@ -1,14 +1,14 @@ --- +applicable: Microsoft Teams +author: serdarsoysal external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: stanlythomas Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Set-CsTeamsMeetingBrandingPolicy -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: stanlythomas -applicable: Microsoft Teams --- # Set-CsTeamsMeetingBrandingPolicy @@ -45,6 +45,21 @@ In this example, the commands will change the brand accent color of the theme in ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultTheme *This parameter is reserved for Microsoft internal use only.* Identity of default meeting theme. @@ -91,6 +106,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Identity of meeting branding policy that will be updated. To refer to the global policy, use this syntax: `-Identity global`. @@ -139,36 +169,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Describes what would happen if you executed the command without actually executing the command. diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration.md similarity index 88% rename from teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration.md index a369ef43c1..7fe47f61a6 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastConfiguration.md @@ -1,23 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbroadcastconfiguration applicable: Microsoft Teams -title: Set-CsTeamsMeetingBroadcastConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbroadcastconfiguration +schema: 2.0.0 +title: Set-CsTeamsMeetingBroadcastConfiguration --- # Set-CsTeamsMeetingBroadcastConfiguration ## SYNOPSIS -Set-CsTeamsMeetingBroadcastConfiguration \[\[-Identity\] \\] \[-Tenant \\] \[-SupportURL \\] \[-AllowSdnProviderForBroadcastMeeting \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] - -Set-CsTeamsMeetingBroadcastConfiguration -SdnProviderName \ -SdnApiTemplateUrl \ \[-Tenant \\] \[-SupportURL \\] \[-AllowSdnProviderForBroadcastMeeting \\] \[-SdnLicenseId \\] \[-SdnApiToken \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] - -Set-CsTeamsMeetingBroadcastConfiguration \[-Tenant \\] \[-SupportURL \\] \[-AllowSdnProviderForBroadcastMeeting \\] \[-Instance \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] +Changes the Teams meeting broadcast configuration settings for the specified tenant. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy.md index 5fda5b675c..25e026d43d 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingBroadcastPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbroadcastpolicy applicable: Microsoft Teams -title: Set-CsTeamsMeetingBroadcastPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbroadcastpolicy +schema: 2.0.0 +title: Set-CsTeamsMeetingBroadcastPolicy --- # Set-CsTeamsMeetingBroadcastPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingConfiguration.md index 10cd0d63f9..106d8d81e4 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingConfiguration.md @@ -1,10 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingconfiguration -applicable: Microsoft Teams -title: Set-CsTeamsMeetingConfiguration schema: 2.0.0 +title: Set-CsTeamsMeetingConfiguration --- # Set-CsTeamsMeetingConfiguration @@ -222,9 +223,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableQoS +### -DisableAppInteractionForAnonymousUsers +Determines if anonymous users can interact with apps in meetings. Set to TRUE to disable App interaction. +Possible values: -Determines whether Quality of Service Marking for real-time media (audio, video, screen/app sharing) is enabled in the tenant. Set this to TRUE to enable and FALSE to disable +- True +- False ```yaml Type: Boolean @@ -238,12 +242,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -EnableQoS -{{Fill Force Description}} +Determines whether Quality of Service Marking for real-time media (audio, video, screen/app sharing) is enabled in the tenant. Set this to TRUE to enable and FALSE to disable ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -254,9 +258,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpURL +### -FeedbackSurveyForAnonymousUsers +Determines if anonymous participants receive surveys to provide feedback about their meeting experience. Set to Disabled to disable anonymous meeting participants to receive surveys. Set to Enabled to allow anonymous meeting participants to receive surveys. +Possible values: -URL to a website where users can obtain assistance on joining the meeting.This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries +- Enabled +- Disabled ```yaml Type: String @@ -265,31 +272,33 @@ Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The only valid input is Global +### -Force + +{{Fill Force Description}} ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Use this parameter to update a saved configuration instance +### -HelpURL + +URL to a website where users can obtain assistance on joining the meeting.This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries ```yaml -Type: PSObject +Type: String Parameter Sets: (All) Aliases: @@ -300,27 +309,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegalURL -URL to a website containing legal information and meeting disclaimers. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries +### -Identity +The only valid input is Global ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LogoURL - -URL to a logo image. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries +### -Instance +Use this parameter to update a saved configuration instance ```yaml -Type: String +Type: PSObject Parameter Sets: (All) Aliases: @@ -331,15 +339,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableAppInteractionForAnonymousUsers -Determines if anonymous users can interact with apps in meetings. Set to TRUE to disable App interaction. -Possible values: - -- True -- False +### -LegalURL +URL to a website containing legal information and meeting disclaimers. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -350,12 +354,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant - -Internal Microsoft use +### -LimitPresenterRolePermissions +When set to True, users within the Tenant will have their presenter role capabilities limited. +When set to False, the presenter role capabilities will not be impacted and will remain as is. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: @@ -366,12 +370,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FeedbackSurveyForAnonymousUsers -Determines if anonymous participants receive surveys to provide feedback about their meeting experience. Set to Disabled to disable anonymous meeting participants to receive surveys. Set to Enabled to allow anonymous meeting participants to receive surveys. -Possible values: +### -LogoURL -- Enabled -- Disabled +URL to a logo image. This would be included in the meeting invite. Please ensure this URL is publicly accessible for invites that go beyond your federation boundaries ```yaml Type: String @@ -380,17 +381,17 @@ Aliases: Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LimitPresenterRolePermissions -When set to True, users within the Tenant will have their presenter role capabilities limited. -When set to False, the presenter role capabilities will not be impacted and will remain as is. +### -Tenant + +Internal Microsoft use ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingPolicy.md index dc1727f4c4..1e169f8d35 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingPolicy.md @@ -1,15 +1,16 @@ --- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingpolicy -Module Name: MicrosoftTeams applicable: Microsoft Teams -title: Set-CsTeamsMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau +ms.date: 02/26/2025 ms.reviewer: alejandramu -ms.date: 2/26/2025 +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingpolicy +schema: 2.0.0 +title: Set-CsTeamsMeetingPolicy --- # Set-CsTeamsMeetingPolicy @@ -168,22 +169,10 @@ This policy will use all the existing values except one: AllowNetworkConfigurati ## PARAMETERS -### -Identity -Specify the name of the policy being created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: +### -AIInterpreter -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams -### -AIInterpreter >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -198,7 +187,6 @@ Possible values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -287,6 +275,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowBreakoutRooms +Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowCarbonSummary This setting will enable Tenant Admins to enable/disable the sharing of location data necessary to provide the end of meeting carbon summary screen for either the entire tenant or for a particular user. @@ -328,8 +331,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowBreakoutRooms -Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. +### -AllowChannelMeetingScheduling +Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. + +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -338,16 +344,13 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelMeetingScheduling -Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. - -> [!NOTE] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. +### -AllowCloudRecording +Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings. ```yaml Type: Boolean @@ -361,11 +364,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCloudRecording -Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings. +### -AllowDocumentCollaboration + +This setting will allow admins to choose which users will be able to use the Document Collaboration feature. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -376,9 +380,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDocumentCollaboration +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. -This setting will allow admins to choose which users will be able to use the Document Collaboration feature. +Possible values are: + +- \ +- RTMP + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingContext +This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingContext + +This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. ```yaml Type: String @@ -392,6 +431,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowedUsersForMeetingDetails +Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. + +Possible Values: +- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. +- Everyone: All meeting participants can see the meeting info details. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: UsersAllowedToByPassTheLobby +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowEngagementReport Determines whether meeting organizers are allowed to download the attendee engagement report. Possible values are: @@ -429,6 +487,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowExternalNonTrustedMeetingChat +This field controls whether a user is allowed to chat in external meetings with users from non-trusted organizations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowExternalParticipantGiveRequestControl Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting. @@ -572,31 +645,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNetworkConfigurationSettingsLookup -Determines whether network configuration setting lookup can be made for users who are not Enterprise Voice enabled. It is used to enable Network Roaming policy. +### -AllowNDIStreaming +This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. ```yaml Type: Boolean Parameter Sets: (All) Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNDIStreaming -This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. +### -AllowNetworkConfigurationSettingsLookup +Determines whether network configuration setting lookup can be made for users who are not Enterprise Voice enabled. It is used to enable Network Roaming policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -661,8 +734,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetNow -This setting controls whether a user can start an ad hoc private meeting. +### -AllowPrivateMeetingScheduling +Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. + +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -676,11 +752,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetingScheduling -Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. - -> [!NOTE] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. +### -AllowPrivateMeetNow +This setting controls whether a user can start an ad hoc private meeting. ```yaml Type: Boolean @@ -800,22 +873,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedUsersForMeetingContext - -This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowUserToJoinExternalMeeting Currently, this parameter has no effect. @@ -837,23 +894,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedUsersForMeetingContext -This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowExternalNonTrustedMeetingChat -This field controls whether a user is allowed to chat in external meetings with users from non-trusted organizations. +### -AllowWatermarkForCameraVideo +This setting allows scheduling meetings with watermarking for video enabled. ```yaml Type: Boolean @@ -862,7 +904,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -882,21 +924,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForCameraVideo -This setting allows scheduling meetings with watermarking for video enabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowWhiteboard Determines whether whiteboard is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. @@ -912,26 +939,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedStreamingMediaInput -Enables the use of RTMP-In in Teams meetings. - -Possible values are: - -- \ -- RTMP - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AnonymousUserAuthenticationMethod Determines how anonymous users will be authenticated when joining a meeting. Possible values are: @@ -986,22 +993,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoRecording - -This setting allows admins to control the visibility of the auto recording feature in the organizer's **Meeting options**. If the you enable this setting, the **Record and transcribe automatically** setting appears in **Meeting options** with the default value set to **Off** (except for webinars and townhalls). Organizers need to manually toggle this setting to **On** to for their meetings to be automatically recorded. If you disable this setting, **Record and transcribe automatically** is hidden, preventing organizers from setting any meetings to be auto-recorded. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AutoAdmittedUsers Determines what types of participants will automatically be added to meetings organized by this user. Possible values are: @@ -1050,6 +1041,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AutoRecording + +This setting allows admins to control the visibility of the auto recording feature in the organizer's **Meeting options**. If the you enable this setting, the **Record and transcribe automatically** setting appears in **Meeting options** with the default value set to **Off** (except for webinars and townhalls). Organizers need to manually toggle this setting to **On** to for their meetings to be automatically recorded. If you disable this setting, **Record and transcribe automatically** is hidden, preventing organizers from setting any meetings to be auto-recorded. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BlockedAnonymousJoinClientTypes A user can join a Teams meeting anonymously using a [Teams client](https://support.microsoft.com/office/join-a-meeting-without-a-teams-account-c6efc38f-4e03-4e79-b28f-e65a4c039508) or using a [custom application built using Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/join-teams-meeting). When anonymous meeting join is enabled, both types of clients may be used by default. This optional parameter can be used to block one of the client types that can be used. @@ -1320,6 +1327,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Specify the name of the policy being created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InfoShownInReportMode This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. @@ -1479,6 +1501,9 @@ Accept wildcard characters: False ``` ### -MeetingInviteLanguages + +> Applicable: Microsoft Teams + Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed. > [!NOTE] @@ -1492,7 +1517,6 @@ The preliminary list of available languages is shown below: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1520,6 +1544,8 @@ Accept wildcard characters: False ``` ### -NoiseSuppressionForDialInParticipants +> Applicable: Microsoft Teams + >[!NOTE] >This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1535,7 +1561,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1564,6 +1589,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParticipantSlideControl + +> Applicable: Microsoft Teams + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Determines whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibited from giving control, or being given control, in a meeting. + +Possible Values: +- Everyone: Anyone in the meeting can give or take control +- EveryoneInOrganization: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control +- EveryoneInOrganizationAndGuests: Only those who are Guests to the tenant, MTO users, and internal AAD users can give or take control +- None: No one in the meeting can give or take control + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PreferredMeetingProviderForIslandsMode Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in. @@ -1599,6 +1651,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RealTimeText + +> Applicable: Microsoft Teams + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecordingStorageMode This parameter can take two possible values: @@ -1835,6 +1912,8 @@ Accept wildcard characters: False ### -VoiceSimulationInInterpreter +> Applicable: Microsoft Teams + > [!NOTE] > This feature has not been released yet and will have no changes if it is enabled or disabled. @@ -1849,7 +1928,6 @@ Possible Values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1938,73 +2016,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedUsersForMeetingDetails -Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. - -Possible Values: -- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. -- Everyone: All meeting participants can see the meeting info details. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: UsersAllowedToByPassTheLobby -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RealTimeText ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. - -Possible Values: -- Enabled: User is allowed to turn on real time text. -- Disabled: User is not allowed to turn on real time text. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParticipantSlideControl ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -Determines whether participants can give control of presentation slides during meetings scheduled by this user. Set the type of users you want to be able to give control and be given control of presentation slides in meetings. Users excluded from the selected group will be prohibited from giving control, or being given control, in a meeting. - -Possible Values: -- Everyone: Anyone in the meeting can give or take control -- EveryoneInOrganization: Only internal AAD users and Multi-Tenant Organization (MTO) users can give or take control -- EveryoneInOrganizationAndGuests: Only those who are Guests to the tenant, MTO users, and internal AAD users can give or take control -- None: No one in the meeting can give or take control - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingTemplatePermissionPolicy.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingTemplatePermissionPolicy.md index e9a319c5d3..9a10b6eada 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -1,11 +1,12 @@ --- +author: boboPD external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsMeetingTemplatePermissionPolicy -author: boboPD ms.author: pradas online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMeetingTemplatePermissionPolicy schema: 2.0.0 +title: Set-CsTeamsMeetingTemplatePermissionPolicy --- # Set-CsTeamsMeetingTemplatePermissionPolicy @@ -43,15 +44,16 @@ Updates the hidden meeting templates array. ## PARAMETERS -### -Identity +### -Description -Name of the policy instance to be updated. +> Applicable: Microsoft Teams + +Pass in a new description if that field needs to be updated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -61,6 +63,8 @@ Accept wildcard characters: False ### -HiddenMeetingTemplates +> Applicable: Microsoft Teams + The updated list of meeting template IDs to hide. The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). @@ -68,7 +72,6 @@ The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemp Type: HiddenMeetingTemplate[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -76,15 +79,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Pass in a new description if that field needs to be updated. +> Applicable: Microsoft Teams + +Name of the policy instance to be updated. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingPolicy.md index d7182ff633..38d1b5d8e0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMessagingPolicy.md @@ -1,9 +1,11 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingpolicy -applicable: Microsoft Teams -title: Set-CsTeamsMessagingPolicy schema: 2.0.0 +title: Set-CsTeamsMessagingPolicy --- # Set-CsTeamsMessagingPolicy @@ -131,38 +133,6 @@ All other policy properties will be left as previously assigned. ## PARAMETERS -### -Identity -Identity for the teams messaging policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: `-Identity TeamsMessagingPolicy`. - -If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowChatWithGroup This setting determines if users can chat with groups (Distribution, M365 and Security groups). Possible values: True, False @@ -718,6 +688,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +Identity for the teams messaging policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: `-Identity TeamsMessagingPolicy`. + +If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InOrganizationChatControl This setting determines if chat regulation for internal communication in the tenant is allowed. @@ -733,6 +720,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ReadReceiptsEnabledType Use this setting to specify whether read receipts are user controlled, enabled for everyone, or disabled. Set this to UserPreference, Everyone or None. diff --git a/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMobilityPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMobilityPolicy.md index 483c23e72a..f4c8bf2b71 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMobilityPolicy.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmobilitypolicy applicable: Microsoft Teams -title: Set-CsTeamsMobilityPolicy -schema: 2.0.0 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US manager: ritikag +Module Name: MicrosoftTeams ms.reviewer: ritikag +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmobilitypolicy +schema: 2.0.0 +title: Set-CsTeamsMobilityPolicy --- # Set-CsTeamsMobilityPolicy @@ -87,23 +89,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IPAudioMobileMode -When set to WifiOnly, prohibits the user from making, receiving calls or joining meetings using VoIP calls on the mobile device while on cellular data connection. +### -Identity +Specify the name of the policy that you are creating. ```yaml -Type: String -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IPVideoMobileMode -When set to WifiOnly, prohibits the user from making, receiving video calls or enabling video in meetings using VoIP calls on the mobile device while on cellular data connection. +### -IPAudioMobileMode +When set to WifiOnly, prohibits the user from making, receiving calls or joining meetings using VoIP calls on the mobile device while on cellular data connection. ```yaml Type: String @@ -117,16 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy that you are creating. +### -IPVideoMobileMode +When set to WifiOnly, prohibits the user from making, receiving video calls or enabling video in meetings using VoIP calls on the mobile device while on cellular data connection. ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: String +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMultiTenantOrganizationConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsMultiTenantOrganizationConfiguration.md index 0e092c6abe..892476c910 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsMultiTenantOrganizationConfiguration.md @@ -1,12 +1,13 @@ --- +applicable: Microsoft Teams +author: samlyu external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-CsTeamsMultiTenantOrganizationConfiguration +ms.author: samlyu online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmultitenantorganizationconfiguration schema: 2.0.0 -author: samlyu -ms.author: samlyu +title: Set-CsTeamsMultiTenantOrganizationConfiguration --- # Set-CsTeamsMultiTenantOrganizationConfiguration @@ -45,32 +46,32 @@ Set Teams Multi-tenant Organization Setting "CopilotFromHomeTenant" value to "En ## PARAMETERS -### -Identity -Identity of the Teams Multi-tenant Organization Setting. +### -CopilotFromHomeTenant +Setting value of the Teams Multi-tenant Organization Setting. CopilotFromHomeTenant controls user access to Copilot license in their home tenant during cross-tenant meetings. ```yaml -Type: String -Parameter Sets: (All) +Type: Boolean +Parameter Sets: ("Enabled","Disabled") Aliases: Required: True Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -CopilotFromHomeTenant -Setting value of the Teams Multi-tenant Organization Setting. CopilotFromHomeTenant controls user access to Copilot license in their home tenant during cross-tenant meetings. +### -Identity +Identity of the Teams Multi-tenant Organization Setting. ```yaml -Type: Boolean -Parameter Sets: ("Enabled","Disabled") +Type: String +Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy.md index f7d01f2e45..6c6a49d8eb 100644 --- a/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNetworkRoamingPolicy.md @@ -1,14 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnetworkroamingpolicy applicable: Microsoft Teams -title: Set-CsTeamsNetworkRoamingPolicy author: TristanChen-msft -ms.author: jiaych -ms.reviewer: +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: mreddy +Module Name: MicrosoftTeams +ms.author: jiaych +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnetworkroamingpolicy schema: 2.0.0 +title: Set-CsTeamsNetworkRoamingPolicy --- # Set-CsTeamsNetworkRoamingPolicy @@ -39,7 +39,7 @@ To enable the network roaming policy for users who are not Enterprise Voice enab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> Set-CsTeamsNetworkRoamingPolicy -Identity "RedmondRoaming" -AllowIPVideo $true -MediaBitRateKb 2000 -Description "Redmond campus roaming policy" ``` @@ -48,63 +48,63 @@ The command shown in Example 1 updates the teams network roaming policy with Id ## PARAMETERS -### -Identity -Unique identifier of the policy to be modified. +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. +Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPVideo -Determines whether video is enabled in a user's meetings or calls. -Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. +### -Description +Description of the policy to be edited. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings. +### -Identity +Unique identifier of the policy to be modified. ```yaml -Type: Integer +Type: XdsIdentity Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 50000 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of the policy to be edited. +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. ```yaml -Type: String +Type: Integer Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: 50000 Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNotificationAndFeedsPolicy.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsNotificationAndFeedsPolicy.md index b5598c89ee..41b5674bc9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsNotificationAndFeedsPolicy.md @@ -1,166 +1,167 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnotificationandfeedspolicy -title: Set-CsTeamsNotificationAndFeedsPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsNotificationAndFeedsPolicy - -## SYNOPSIS - -Modifies an existing Teams Notifications and Feeds Policy - -## SYNTAX - -```powershell -Set-CsTeamsNotificationAndFeedsPolicy [-Description ] [[-Identity] ] - [-SuggestedFeedsEnabledType ] [-TrendingFeedsEnabledType ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsNotificationAndFeedsPolicy Global -SuggestedFeedsEnabledType EnabledUserOverride -``` - -Change settings on an existing Notifications and Feeds Policy. - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Free format text - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier assigned to the policy when it was created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuggestedFeedsEnabledType - -The SuggestedFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about suggested activities and content within their Teams environment. When enabled, this parameter ensures that users are notified about recommended or relevant activities, helping them stay informed and engaged with important updates and interactions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrendingFeedsEnabledType - -The TrendingFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about trending activities within their Teams environment. When enabled, this parameter ensures that users are notified about popular or important activities, helping them stay informed about significant updates and interactions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnotificationandfeedspolicy +schema: 2.0.0 +title: Set-CsTeamsNotificationAndFeedsPolicy +--- + +# Set-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS + +Modifies an existing Teams Notifications and Feeds Policy + +## SYNTAX + +```powershell +Set-CsTeamsNotificationAndFeedsPolicy [-Description ] [[-Identity] ] + [-SuggestedFeedsEnabledType ] [-TrendingFeedsEnabledType ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsNotificationAndFeedsPolicy Global -SuggestedFeedsEnabledType EnabledUserOverride +``` + +Change settings on an existing Notifications and Feeds Policy. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Free format text + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuggestedFeedsEnabledType + +The SuggestedFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about suggested activities and content within their Teams environment. When enabled, this parameter ensures that users are notified about recommended or relevant activities, helping them stay informed and engaged with important updates and interactions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrendingFeedsEnabledType + +The TrendingFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about trending activities within their Teams environment. When enabled, this parameter ensures that users are notified about popular or important activities, helping them stay informed about significant updates and interactions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRecordingRollOutPolicy.md similarity index 98% rename from teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsRecordingRollOutPolicy.md index f41ad5f975..c56849374c 100644 --- a/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRecordingRollOutPolicy.md @@ -1,13 +1,14 @@ --- +applicable: Microsoft Teams +author: ronwa external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +Locale: en-US +manager: yujin1 +Module Name: MicrosoftTeams +ms.author: ronwa online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsrecordingrolloutpolicy schema: 2.0.0 -applicable: Microsoft Teams title: Set-CsTeamsRecordingRollOutPolicy -manager: yujin1 -author: ronwa -ms.author: ronwa --- # Set-CsTeamsRecordingRollOutPolicy diff --git a/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md index 171a3e9cd7..04ccc54d56 100644 --- a/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -1,225 +1,228 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsroomvideoteleconferencingpolicy -title: Set-CsTeamsRoomVideoTeleConferencingPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsRoomVideoTeleConferencingPolicy - -## SYNOPSIS - -Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. - -## SYNTAX - -```powershell -Set-CsTeamsRoomVideoTeleConferencingPolicy [-AreaCode ] [-Description ] [-Enabled ] - [[-Identity] ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] - [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). - -## PARAMETERS - -### -AreaCode - -GUID provided by the CVI partner that the customer signed the agreement with - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled - -The policy can exist for the tenant but it can be enabled or disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the policy to be modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceExternalCalls - -The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlaceInternalCalls - -The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveExternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveInternalCalls - -The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant -Value: Enabled, Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsroomvideoteleconferencingpolicy +schema: 2.0.0 +title: Set-CsTeamsRoomVideoTeleConferencingPolicy +--- + +# Set-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +``` +Set-CsTeamsRoomVideoTeleConferencingPolicy [-AreaCode ] [-Description ] [-Enabled ] + [[-Identity] ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] + [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## EXAMPLES + +## PARAMETERS + +### -AreaCode + +GUID provided by the CVI partner that the customer signed the agreement with + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + +The policy can exist for the tenant but it can be enabled or disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceExternalCalls + +The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceInternalCalls + +The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveExternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveInternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSettingsCustomApp.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSettingsCustomApp.md index 455aab2ff0..e71e42bb5a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSettingsCustomApp.md @@ -1,95 +1,96 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp -title: Set-CsTeamsSettingsCustomApp -schema: 2.0.0 ---- - -# Set-CsTeamsSettingsCustomApp - -## SYNOPSIS -Set the Custom Apps Setting's value of Teams Admin Center. - -## SYNTAX - -``` -Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -There is a switch for managing Custom Apps in the Org-wide App Settings page of Teams Admin Center. The command can set the value of this switch. If the isSideloadedAppsInteractionEnabled is set to true, the switch is enabled. So that the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled $True -``` - -Set the value of Custom Apps Setting to true. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -isSideloadedAppsInteractionEnabled -The value to Custom Apps Setting. If the value is true, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS -[Get-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp +schema: 2.0.0 +title: Set-CsTeamsSettingsCustomApp +--- + +# Set-CsTeamsSettingsCustomApp + +## SYNOPSIS +Set the Custom Apps Setting's value of Teams Admin Center. + +## SYNTAX + +``` +Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +There is a switch for managing Custom Apps in the Org-wide App Settings page of Teams Admin Center. The command can set the value of this switch. If the isSideloadedAppsInteractionEnabled is set to true, the switch is enabled. So that the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled $True +``` + +Set the value of Custom Apps Setting to true. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -isSideloadedAppsInteractionEnabled +The value to Custom Apps Setting. If the value is true, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Get-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSharedCallingRoutingPolicy.md similarity index 98% rename from teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSharedCallingRoutingPolicy.md index 31c805cfbb..5935ff6b17 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSharedCallingRoutingPolicy.md @@ -1,15 +1,13 @@ --- +applicable: Microsoft Teams +author: serdarsoysal external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy -applicable: Microsoft Teams -title: Set-CsTeamsSharedCallingRoutingPolicy schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: - +title: Set-CsTeamsSharedCallingRoutingPolicy --- # Set-CsTeamsSharedCallingRoutingPolicy @@ -45,17 +43,20 @@ The command shown in Example 1 removes the emergency callback number +1425555667 ## PARAMETERS -### -Identity -Unique identifier of the Teams shared calling routing policy to be created. +### -Confirm + +> Applicable: Microsoft Teams + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -98,69 +99,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceAccount -The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. +### -Force -The phone number assigned to the resource account must: -- Have the same phone number type and country as the emergency numbers configured in this policy instance. -- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. -- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. +> Applicable: Microsoft Teams -The same resource account can be used in multiple shared calling policy instances. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi -Required: True +Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity +Unique identifier of the Teams shared calling routing policy to be created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -ResourceAccount +The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. + +The phone number assigned to the resource account must: +- Have the same phone number type and country as the emergency numbers configured in this policy instance. +- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. +- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. + +The same resource account can be used in multiple shared calling policy instances. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams +Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf + +> Applicable: Microsoft Teams + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsAppPolicy.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsAppPolicy.md index abbbb97e70..f2a563d097 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsAppPolicy.md @@ -1,133 +1,134 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsapppolicy -title: Set-CsTeamsShiftsAppPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsShiftsAppPolicy - -## SYNOPSIS - -Allows you to set or update properties of a Teams Shifts App Policy instance. - -## SYNTAX - -```powershell -Set-CsTeamsShiftsAppPolicy [-AllowTimeClockLocationDetection ] [[-Identity] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsShiftsAppPolicy 'Default' -AllowTimeClockLocationDetection $False -``` - -Change Settings on a Teams Shift App Policy (only works on Global policy) - -## PARAMETERS - -### -AllowTimeClockLocationDetection - -Turns on the location detection. The time report will indicate whether workers are "on location" when they clocked in and out. Workers are considered as "on location" if they clock in or out within a 200-meter radius of the set location. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Policy instance name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsapppolicy +schema: 2.0.0 +title: Set-CsTeamsShiftsAppPolicy +--- + +# Set-CsTeamsShiftsAppPolicy + +## SYNOPSIS + +Allows you to set or update properties of a Teams Shifts App Policy instance. + +## SYNTAX + +```powershell +Set-CsTeamsShiftsAppPolicy [-AllowTimeClockLocationDetection ] [[-Identity] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsShiftsAppPolicy 'Default' -AllowTimeClockLocationDetection $False +``` + +Change Settings on a Teams Shift App Policy (only works on Global policy) + +## PARAMETERS + +### -AllowTimeClockLocationDetection + +Turns on the location detection. The time report will indicate whether workers are "on location" when they clocked in and out. Workers are considered as "on location" if they clock in or out within a 200-meter radius of the set location. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Policy instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnection.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnection.md index dd1eca6bb1..d333cc2984 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnection.md @@ -1,12 +1,13 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Set-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: valk online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection schema: 2.0.0 +title: Set-CsTeamsShiftsConnection --- # Set-CsTeamsShiftsConnection @@ -168,6 +169,21 @@ In case of an error, you can capture the error response as follows: ## PARAMETERS +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Body The request body. @@ -228,6 +244,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectorId +Used to specify the unique identifier of the connector being used for the connection. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +The connector-specific settings. + +```yaml +Type: IUpdateWfmConnectionRequestConnectorSpecificSettings +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HttpPipelineAppend SendAsync Pipeline Steps to be appended to the front of the pipeline. @@ -303,21 +364,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector-specific settings. - -```yaml -Type: IUpdateWfmConnectionRequestConnectorSpecificSettings -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Proxy The URI for the proxy server to use. @@ -394,51 +440,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorId -Used to specify the unique identifier of the connector being used for the connection. - -```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Etag -Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. - -```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnectionInstance.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnectionInstance.md index eb62460fc0..7b625a0c06 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,13 @@ --- +author: leonardospina external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: valk Module Name: MicrosoftTeams -title: Set-CsTeamsShiftsConnectionInstance -author: leonardospina ms.author: lespina -manager: valk online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Set-CsTeamsShiftsConnectionInstance --- # Set-CsTeamsShiftsConnectionInstance @@ -165,6 +166,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectionId +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ConnectorAdminEmail Gets or sets the list of connector admin email addresses. @@ -193,8 +208,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId -Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -DesignatedActorId +Gets or sets the designated actor ID that App acts as for Shifts Graph API calls. ```yaml Type: String @@ -207,54 +222,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -Gets or sets the designated actor ID that App acts as for Shifts Graph API calls. +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -IfMatch +The value of the etag field as returned by the cmdlets. ```yaml Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Parameter Sets: (All) Aliases: Required: True Position: Named @@ -263,22 +279,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -InputObject +Identity Parameter. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: SetViaIdentityExpanded, SetViaIdentity Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SyncScenarioSwapRequest -The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Name +The connector instance name. ```yaml Type: String @@ -291,50 +307,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: Uri +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String @@ -347,40 +363,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -SyncFrequencyInMin +The sync frequency in minutes. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: Int32 +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The value of the etag field as returned by the cmdlets. +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: Required: True Position: Named @@ -389,22 +405,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: SetViaIdentityExpanded, SetViaIdentity +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connector instance name. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -417,50 +433,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Uri -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: PSCredential -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String @@ -473,11 +489,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin -The sync frequency in minutes. +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Int32 +Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: Required: True @@ -502,21 +518,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Etag -Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. - -```yaml -Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsPolicy.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsPolicy.md index 6835a0dfa9..2bd2f48686 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsShiftsPolicy.md @@ -1,220 +1,235 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-teamsshiftspolicy -title: Set-CsTeamsShiftsPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsShiftsPolicy - -## SYNOPSIS - -This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. - -## SYNTAX - -```powershell -Set-CsTeamsShiftsPolicy [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] - [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] - [-EnableScheduleOwnerPermissions ] [-Identity] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance. Use this to set the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 -``` -In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", a warning message (Message 1) will always be displayed to the user on opening Teams during off shift hours. - -## PARAMETERS - -### -Identity -Policy instance name. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessType -Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. -Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. -For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: UnrestrictedAccess_TeamsApp -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageType -The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. -'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. -'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. -'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. -'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. -'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. -'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. -'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. -'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. -'CustomMessage' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: DefaultMessage -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeMessageCustom -Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftNoticeFrequency -Frequency of warning dialog displayed when user opens Teams. Set one of Always, ShowOnceOnChange, Never. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: Always -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessGracePeriodMinutes -Indicates the grace period time in minutes between when the first shift starts, or last shift ends and when access is blocked. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableScheduleOwnerPermissions -Indicates whether a user can manage a Shifts schedule as a team member. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) - -[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) - -[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) - -[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-teamsshiftspolicy +schema: 2.0.0 +title: Set-CsTeamsShiftsPolicy +--- + +# Set-CsTeamsShiftsPolicy + +## SYNOPSIS + +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. + +## SYNTAX + +```powershell +Set-CsTeamsShiftsPolicy [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] + [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] + [-EnableScheduleOwnerPermissions ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance. Use this to set the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 +``` +In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", a warning message (Message 1) will always be displayed to the user on opening Teams during off shift hours. + +## PARAMETERS + +### -AccessGracePeriodMinutes + +> Applicable: Microsoft Teams + +Indicates the grace period time in minutes between when the first shift starts, or last shift ends and when access is blocked. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AccessType + +> Applicable: Microsoft Teams + +Indicates the Teams access type granted to the user. Today, only unrestricted access to Teams app is supported. +Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. +For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: UnrestrictedAccess_TeamsApp +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableScheduleOwnerPermissions + +> Applicable: Microsoft Teams + +Indicates whether a user can manage a Shifts schedule as a team member. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Microsoft Teams + +Policy instance name. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeFrequency + +> Applicable: Microsoft Teams + +Frequency of warning dialog displayed when user opens Teams. Set one of Always, ShowOnceOnChange, Never. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: Always +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageCustom + +> Applicable: Microsoft Teams + +Provide a custom message. Must set ShiftNoticeMessageType to 'CustomMessage' to enforce this. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftNoticeMessageType + +> Applicable: Microsoft Teams + +The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. +'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. +'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. +'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. +'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. +'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. +'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. +'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. +'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. +'CustomMessage' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: DefaultMessage +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) + +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) + +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) + +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSipDevicesConfiguration.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSipDevicesConfiguration.md index 2163f1d2f1..82a0dba450 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSipDevicesConfiguration.md @@ -1,11 +1,12 @@ --- +author: anmandav external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Set-CsTeamsSipDevicesConfiguration -author: anmandav ms.author: anmandav online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssipdevicesconfiguration schema: 2.0.0 +title: Set-CsTeamsSipDevicesConfiguration --- # Set-CsTeamsSipDevicesConfiguration diff --git a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliance.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliance.md index 49fabb2ff1..cdcb20cad9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliance.md @@ -1,135 +1,140 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliance -title: Set-CsTeamsSurvivableBranchAppliance -schema: 2.0.0 ---- - -# Set-CsTeamsSurvivableBranchAppliance - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Set-CsTeamsSurvivableBranchAppliance [-Description ] [[-Identity] ] [-Site ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Description of the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -The TenantNetworkSite where the SBA is located. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliance +schema: 2.0.0 +title: Set-CsTeamsSurvivableBranchAppliance +--- + +# Set-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS +Changes the Survivable Branch Appliance (SBA) configuration settings for the specified tenant. + +## SYNTAX + +``` +Set-CsTeamsSurvivableBranchAppliance [-Description ] [[-Identity] ] [-Site ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site + +The TenantNetworkSite where the SBA is located. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliancePolicy.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliancePolicy.md index fe8cc3c54b..09492ec96e 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsSurvivableBranchAppliancePolicy.md @@ -1,119 +1,124 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliancepolicy -title: Set-CsTeamsSurvivableBranchAppliancePolicy -schema: 2.0.0 ---- - -# Set-CsTeamsSurvivableBranchAppliancePolicy - -## SYNOPSIS - -The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. - -## SYNTAX - -```powershell -Set-CsTeamsSurvivableBranchAppliancePolicy [-BranchApplianceFqdns ] [[-Identity] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] -``` - -## PARAMETERS - -### -BranchApplianceFqdns - -The FQDN of the SBA(s) in the site. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliancepolicy +schema: 2.0.0 +title: Set-CsTeamsSurvivableBranchAppliancePolicy +--- + +# Set-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS +Changes the Survivable Branch Appliance (SBA) Policy configuration settings for the specified tenant. + +## SYNTAX + +``` +Set-CsTeamsSurvivableBranchAppliancePolicy [-BranchApplianceFqdns ] [[-Identity] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## EXAMPLES + +## PARAMETERS + +### -BranchApplianceFqdns + +The FQDN of the SBA(s) in the site. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTargetingPolicy.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsTargetingPolicy.md index f1e5d3000d..00278cbf1c 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTargetingPolicy.md @@ -1,204 +1,202 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy -title: Set-CsTeamsTargetingPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsTargetingPolicy - -## SYNOPSIS - -The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. - -## SYNTAX - -```powershell -Set-CsTeamsTargetingPolicy [-CustomTagsMode ] [-Description ] [[-Identity] ] - [-ManageTagsPermissionMode ] [-ShiftBackedTagsMode ] [-SuggestedPresetTags ] - [-TeamOwnersEditWhoCanManageTagsMode ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. - -The Set-CsTeamsTargetingPolicy cmdlet allows administrators to update existing Tenant tag settings that can be assigned to particular teams to control Team features related to tags. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsTargetingPolicy -Identity NewTagPolicy -CustomTagsMode Enabled -``` - -The command shown in Example 1 uses the Set-CsTeamsTargetingPolicy cmdlet to update an existing Tenant tag setting with the CustomTagsMode Enabled. This flag will enable Teams users to create tags. - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomTagsMode - -Determine whether Teams users can create tags in team. Set this to Enabled to allow users to create new tags. Set this to Disabled to prohibit them from creating new tags. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Pass in a new description if that field needs to be updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Name of the policy instance to be updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManageTagsPermissionMode - -Determine whether team users can manage tag settings in Teams. Set this to EnabledTeamOwner to only allow Teams owners to manage tag settings in current Teams. Set this to EnabledTeamOwnerMember to allow Teams owners and Teams members to manage tag settings in current Teams. Set this to EnabledTeamOwnerMemberGuest to allow Teams owners, Teams members and guest users to manage tag settings in current Teams. Set this to MicrosoftDefault to user default setting in current Teams, which will be the same as EnabledTeamOwner. Set this to Disabled to prohibit all users from managing tag settings in current Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For Internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShiftBackedTagsMode - -Determine whether Teams can have tags created by Shift App. Set this to Enabled to allow tags created by Shift App. Set this to Disabled to prohibit tags from Shift App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamOwnersEditWhoCanManageTagsMode - -Determine whether Teams owners can change Tenant tag settings. Set this to Enabled to allow Teams owners to change Tenant tag settings for current Teams. Set this to Disabled to prohibit them from changing Tenant tag settings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) -[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy +schema: 2.0.0 +title: Set-CsTeamsTargetingPolicy +--- + +# Set-CsTeamsTargetingPolicy + +## SYNOPSIS +The Set-CsTeamsTargetingPolicy cmdlet allows administrators to update existing Tenant tag settings that can be assigned to particular teams to control Team features related to tags. + +## SYNTAX + +```powershell +Set-CsTeamsTargetingPolicy [-CustomTagsMode ] [-Description ] [[-Identity] ] + [-ManageTagsPermissionMode ] [-ShiftBackedTagsMode ] [-SuggestedPresetTags ] + [-TeamOwnersEditWhoCanManageTagsMode ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsTargetingPolicy -Identity NewTagPolicy -CustomTagsMode Enabled +``` + +The command shown in Example 1 uses the Set-CsTeamsTargetingPolicy cmdlet to update an existing Tenant tag setting with the CustomTagsMode Enabled. This flag will enable Teams users to create tags. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomTagsMode + +Determine whether Teams users can create tags in team. Set this to Enabled to allow users to create new tags. Set this to Disabled to prohibit them from creating new tags. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Pass in a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageTagsPermissionMode + +Determine whether team users can manage tag settings in Teams. Set this to EnabledTeamOwner to only allow Teams owners to manage tag settings in current Teams. Set this to EnabledTeamOwnerMember to allow Teams owners and Teams members to manage tag settings in current Teams. Set this to EnabledTeamOwnerMemberGuest to allow Teams owners, Teams members and guest users to manage tag settings in current Teams. Set this to MicrosoftDefault to user default setting in current Teams, which will be the same as EnabledTeamOwner. Set this to Disabled to prohibit all users from managing tag settings in current Teams. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftBackedTagsMode + +Determine whether Teams can have tags created by Shift App. Set this to Enabled to allow tags created by Shift App. Set this to Disabled to prohibit tags from Shift App. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamOwnersEditWhoCanManageTagsMode + +Determine whether Teams owners can change Tenant tag settings. Set this to Enabled to allow Teams owners to change Tenant tag settings for current Teams. Set this to Disabled to prohibit them from changing Tenant tag settings. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTemplatePermissionPolicy.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsTemplatePermissionPolicy.md index 8aa49764df..b4fb19c39a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTemplatePermissionPolicy.md @@ -1,155 +1,155 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy -title: Set-CsTeamsTemplatePermissionPolicy -author: yishuaihuang4 -ms.author: yishuaihuang -ms.reviewer: -manager: weiliu2 -schema: 2.0.0 ---- - -# Set-CsTeamsTemplatePermissionPolicy - -## SYNOPSIS -This cmdlet updates an existing TeamsTemplatePermissionPolicy. - -## SYNTAX - -``` -Set-CsTeamsTemplatePermissionPolicy - [-HiddenTemplates ] - [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Updates any of the properties of an existing instance of the TeamsTemplatePermissionPolicy. - -## EXAMPLES - -### Example 1 -```powershell -PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent -PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject -PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) -PS >Set-CsTeamsTemplatePermissionPolicy -Identity Global -HiddenTemplates $HiddenList -``` - -Updates the hidden templates array. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Adds a new description if that field needs to be updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. - -You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HiddenTemplates -The updated list of Teams template IDs to hide. -The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). - -```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Name of the policy instance to be updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) - -[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) - -[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) +--- +author: yishuaihuang4 +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: weiliu2 +Module Name: MicrosoftTeams +ms.author: yishuaihuang +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy +schema: 2.0.0 +title: Set-CsTeamsTemplatePermissionPolicy +--- + +# Set-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +This cmdlet updates an existing TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +Set-CsTeamsTemplatePermissionPolicy + [-HiddenTemplates ] + [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Updates any of the properties of an existing instance of the TeamsTemplatePermissionPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) +PS >Set-CsTeamsTemplatePermissionPolicy -Identity Global -HiddenTemplates $HiddenList +``` + +Updates the hidden templates array. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Adds a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenTemplates +The updated list of Teams template IDs to hide. +The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) + +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTranslationRule.md similarity index 98% rename from teams/teams-ps/teams/Set-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsTranslationRule.md index 64bcdc16c5..7d8c64964c 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule applicable: Microsoft Teams -title: Set-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: nmurav +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule +schema: 2.0.0 +title: Set-CsTeamsTranslationRule --- # Set-CsTeamsTranslationRule @@ -36,16 +37,16 @@ This example modifies the rule that initially configured to strip +1206555 from ## PARAMETERS -### -Identity -Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -66,8 +67,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Pattern -A regular expression that caller or callee number must match in order for this rule to be applied. +### -Identity +Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. ```yaml Type: String @@ -75,14 +76,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Translation -The regular expression pattern that will be applied to the number to convert it. +### -Pattern +A regular expression that caller or callee number must match in order for this rule to be applied. ```yaml Type: String @@ -96,13 +97,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. +### -Translation +The regular expression pattern that will be applied to the number to convert it. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -111,13 +112,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUnassignedNumberTreatment.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsUnassignedNumberTreatment.md index 75ea8483a8..8578a7978e 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUnassignedNumberTreatment.md @@ -1,166 +1,165 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment -applicable: Microsoft Teams -title: Set-CsTeamsUnassignedNumberTreatment -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsTeamsUnassignedNumberTreatment - -## SYNOPSIS -Changes a treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. - -## SYNTAX - -``` -Set-CsTeamsUnassignedNumberTreatment [[-Identity] ] [-Description ] [-Pattern ] [-Target ] [-TargetType ] - [-TreatmentPriority ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet changes a treatment for how calls to an unassigned number range should be routed. - -## EXAMPLES - -### Example 1 -```powershell -$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa2@contoso.com).ObjectId -Set-CsTeamsUnassignedNumberTreatment -Identity MainAA -Target $RAObjectId -``` -This example changes the treatment MainAA to route the calls to the resource account aa2@contoso.com. - -### Example 2 -```powershell -$UserObjectId = (Get-CsOnlineUser -Identity user2@contoso.com).Identity -Set-CsTeamsUnassignedNumberTreatment -Identity User2PSTN -TargetType User -Target $UserObjectId -``` -This example changes the treatment User2PSTN to route the calls to the user user2@contoso.com. - -## PARAMETERS - -### -Description -Free format description of this treatment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Id of the specific treatment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern -A regular expression that the called number must match in order for the treatment to take effect. It is best practice to start the regular expression with the hat character and end it with the dollar character. -You can use various regular expression test sites on the Internet to validate the expression. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetType -The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TreatmentPriority -The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. - -```yaml -Type: System.Integer -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Object - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.5.1 or later. - -Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. - -To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. - -To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. - -If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to -the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains -a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. - -## RELATED LINKS -[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) - -[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) - -[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) - -[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) - -[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment +schema: 2.0.0 +title: Set-CsTeamsUnassignedNumberTreatment +--- + +# Set-CsTeamsUnassignedNumberTreatment + +## SYNOPSIS +Changes a treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. + +## SYNTAX + +``` +Set-CsTeamsUnassignedNumberTreatment [[-Identity] ] [-Description ] [-Pattern ] [-Target ] [-TargetType ] + [-TreatmentPriority ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet changes a treatment for how calls to an unassigned number range should be routed. + +## EXAMPLES + +### Example 1 +```powershell +$RAObjectId = (Get-CsOnlineApplicationInstance -Identity aa2@contoso.com).ObjectId +Set-CsTeamsUnassignedNumberTreatment -Identity MainAA -Target $RAObjectId +``` +This example changes the treatment MainAA to route the calls to the resource account aa2@contoso.com. + +### Example 2 +```powershell +$UserObjectId = (Get-CsOnlineUser -Identity user2@contoso.com).Identity +Set-CsTeamsUnassignedNumberTreatment -Identity User2PSTN -TargetType User -Target $UserObjectId +``` +This example changes the treatment User2PSTN to route the calls to the user user2@contoso.com. + +## PARAMETERS + +### -Description +Free format description of this treatment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the specific treatment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that the called number must match in order for the treatment to take effect. It is best practice to start the regular expression with the hat character and end it with the dollar character. +You can use various regular expression test sites on the Internet to validate the expression. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Target +The identity of the destination the call should be routed to. Depending on the TargetType it should either be the ObjectId of the user or application instance/resource account or the AudioFileId of the uploaded audio file. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetType +The type of target used for the treatment. Allowed values are User, ResourceAccount and Announcement. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TreatmentPriority +The priority of the treatment. Used to distinguish identical patterns. The lower the priority the higher preference. The priority needs to be unique. + +```yaml +Type: System.Integer +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.5.1 or later. + +Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. + +To route calls to unassigned Microsoft Calling Plan subscriber numbers, your tenant needs to have available Communications Credits. + +To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. + +If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to +the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains +a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. + +## RELATED LINKS +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) + +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) + +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) + +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) + +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpdateManagementPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpdateManagementPolicy.md index 5d5806b15b..a579a9662b 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpdateManagementPolicy.md @@ -1,13 +1,14 @@ --- +applicable: Microsoft Teams +author: vargasj-ms external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: gnamun Module Name: MicrosoftTeams +ms.author: vargasj online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsupdatemanagementpolicy -applicable: Microsoft Teams -title: Set-CsTeamsUpdateManagementPolicy schema: 2.0.0 -author: vargasj-ms -ms.author: vargasj -manager: gnamun +title: Set-CsTeamsUpdateManagementPolicy --- # Set-CsTeamsUpdateManagementPolicy @@ -41,41 +42,6 @@ In this example, the policy "Campaign Policy" is modified, disabling the in-prod ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledInProductMessages -List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: - -| ID | Campaign Category | -| -- | -- | -| 91382d07-8b89-444c-bbcb-cfe43133af33 | What's New | -| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | - -```yaml -Type: System.Management.Automation.PSListModifier`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowManagedUpdates Enables/Disables managed updates for the user. @@ -165,6 +131,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. @@ -181,12 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateDayOfWeek +### -DisabledInProductMessages +List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: - Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. +| ID | Campaign Category | +| -- | -- | +| 91382d07-8b89-444c-bbcb-cfe43133af33 | What's New | +| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | ```yaml -Type: Int64 +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) Aliases: @@ -197,12 +182,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTime - -Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -213,12 +197,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UpdateTimeOfDay +### -Identity +The unique identifier of the policy. -Machine local time. Can be set only when AllowManagedUpdates is set to True +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OCDIRedirect +This setting controls whether users are redirected from teams.microsoft.com to the unified domain teams.cloud.microsoft. Possible values are: +- **Microsoft Default**, Microsoft will manage redirection behavior. If no explicit admin configuration is set, users may be redirected automatically. +- **Disabled**, Users will remain on teams.microsoft.com. Use this if your organization's apps are incompatible with the unified domain. +- **Enabled**, Users will be redirected to teams.cloud.microsoft. Use this only if your organization had previously opted out of redirection and now wants to opt back in. ```yaml -Type: DateTime +Type: String Parameter Sets: (All) Aliases: @@ -229,17 +229,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNewTeamsClient +### -UpdateDayOfWeek -This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. - If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. - If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. - If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. - If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. - If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. + Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. ```yaml -Type: String +Type: Int64 Parameter Sets: (All) Aliases: @@ -250,11 +245,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OCDIRedirect -This setting controls whether users are redirected from teams.microsoft.com to the unified domain teams.cloud.microsoft. Possible values are: -- **Microsoft Default**, Microsoft will manage redirection behavior. If no explicit admin configuration is set, users may be redirected automatically. -- **Disabled**, Users will remain on teams.microsoft.com. Use this if your organization's apps are incompatible with the unified domain. -- **Enabled**, Users will be redirected to teams.cloud.microsoft. Use this only if your organization had previously opted out of redirection and now wants to opt back in. +### -UpdateTime + +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. + ```yaml Type: String Parameter Sets: (All) @@ -267,11 +261,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) Aliases: @@ -282,16 +277,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The unique identifier of the policy. +### -UseNewTeamsClient + +This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. + If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. + If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. + If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. + If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. + If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpgradeConfiguration.md similarity index 92% rename from teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpgradeConfiguration.md index 001f0dbe19..185ebc0ced 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsUpgradeConfiguration.md @@ -1,15 +1,17 @@ --- +applicable: Microsoft Teams external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration -applicable: Microsoft Teams -title: Set-CsTeamsUpgradeConfiguration schema: 2.0.0 +title: Set-CsTeamsUpgradeConfiguration --- # Set-CsTeamsUpgradeConfiguration ## SYNOPSIS -Administrators can use Set-CsTeamsUpgradeConfiguration to manage certain aspects of client behavior for users being upgraded from Skype for Business to Teams. TeamsUpgradeConfiguration should be used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. It allows administrators to determine which application end users should use to join Skype for Business meetings. +Manage certain aspects of client behavior for users being upgraded from Skype for Business to Teams. ## SYNTAX @@ -43,14 +45,15 @@ The above cmdlet specifies that users subject to upgrade should download Teams i ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -BlockLegacyAuthorization +This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. +If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. +If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams +Aliases: Required: False Position: Named @@ -59,33 +62,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DownloadTeams -The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This Boolean setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SfBMeetingJoinUx -The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: "SkypeMeetingsApp" and "NativeLimitedClient". "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. + +### -DownloadTeams +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This Boolean setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. ```yaml -Type: string +Type: Boolean Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: NativeLimitedClient +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` @@ -121,30 +125,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal use only. +### -SfBMeetingJoinUx +The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: "SkypeMeetingsApp" and "NativeLimitedClient". "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. ```yaml -Type: Guid +Type: string Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: NativeLimitedClient Accept pipeline input: False Accept wildcard characters: False ``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Tenant +For internal use only. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi +Aliases: applicable: Microsoft Teams Required: False @@ -154,15 +156,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockLegacyAuthorization -This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. -If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. -If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users - +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi +applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVdiPolicy.md similarity index 91% rename from teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsVdiPolicy.md index 5c21d8c52c..d4b872b5dc 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVdiPolicy.md @@ -1,165 +1,164 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-cteamsvdipolicy -title: Set-CsTeamsVdiPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsVdiPolicy - -## SYNOPSIS -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -## SYNTAX - -```powershell -Set-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] - [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. - -The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" -``` - -The command shown in Example 1 uses the Set-CsTeamsVdiPolicy cmdlet to update an existing vdi policy with the Identity RestrictedUserPolicy. This policy will use all the existing values except one: VDI2Optimization; in this example, users with this policy can not be in VDI 2.0 optimized. - -### Example 2 -```powershell -PS C:\> Set-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True -``` - -In Example 2, the Set-CsTeamsVdiPolicy cmdlet is used to update a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the existing values. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAudioVideoInCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableCallsAndMeetings -Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VDI2Optimization -Determines whether a user can be VDI 2.0 optimized. -* Enabled - allow a user to be VDI 2.0 optimized. -* Disabled - disallow a user to be VDI 2.0 optimized. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-cteamsvdipolicy +schema: 2.0.0 +title: Set-CsTeamsVdiPolicy +--- + +# Set-CsTeamsVdiPolicy + +## SYNOPSIS +The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. + +## SYNTAX + +```powershell +Set-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] + [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" +``` + +The command shown in Example 1 uses the Set-CsTeamsVdiPolicy cmdlet to update an existing vdi policy with the Identity RestrictedUserPolicy. This policy will use all the existing values except one: VDI2Optimization; in this example, users with this policy can not be in VDI 2.0 optimized. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True +``` + +In Example 2, the Set-CsTeamsVdiPolicy cmdlet is used to update a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the existing values. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableAudioVideoInCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VDI2Optimization +Determines whether a user can be VDI 2.0 optimized. +* Enabled - allow a user to be VDI 2.0 optimized. +* Disabled - disallow a user to be VDI 2.0 optimized. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVirtualAppointmentsPolicy.md similarity index 98% rename from teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsVirtualAppointmentsPolicy.md index 363ba6ac2f..faaedf05b3 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVirtualAppointmentsPolicy.md @@ -1,12 +1,13 @@ --- +author: emmanuelrocha001 external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: sonaggarwal Module Name: MicrosoftTeams +ms.author: erocha online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy -title: Set-CsTeamsVirtualAppointmentsPolicy schema: 2.0.0 -author: emmanuelrocha001 -ms.author: erocha -manager: sonaggarwal +title: Set-CsTeamsVirtualAppointmentsPolicy --- # Set-CsTeamsVirtualAppointmentsPolicy @@ -52,13 +53,15 @@ Accept wildcard characters: False ``` ### -EnableSmsNotifications + +> Applicable: Microsoft Teams + This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment template meeting. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVoiceApplicationsPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsVoiceApplicationsPolicy.md index e39d07bd9a..09330aa598 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -1,9 +1,10 @@ --- external help file: MicrosoftTeams-help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy -title: Set-CsTeamsVoiceApplicationsPolicy schema: 2.0.0 +title: Set-CsTeamsVoiceApplicationsPolicy --- # Set-CsTeamsVoiceApplicationsPolicy @@ -74,9 +75,9 @@ The command shown in Example 1 sets allowing CQ overflow shared voicemail greeti ## PARAMETERS -### -AllowAutoAttendantBusinessHoursGreetingChange +### -AllowAutoAttendantAfterHoursGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. ```yaml Type: Boolean @@ -90,9 +91,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursGreetingChange +### -AllowAutoAttendantAfterHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. ```yaml Type: Boolean @@ -106,9 +107,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayGreetingChange +### -AllowAutoAttendantBusinessHoursChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. ```yaml Type: Boolean @@ -122,9 +123,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursChange +### -AllowAutoAttendantBusinessHoursGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -138,9 +139,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidaysChange +### -AllowAutoAttendantBusinessHoursRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. ```yaml Type: Boolean @@ -154,11 +155,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantTimeZoneChange - -_This feature is not currently available to authorized users._ +### -AllowAutoAttendantHolidayGreetingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. ```yaml Type: Boolean @@ -172,11 +171,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantLanguageChange - -_This feature is not currently available to authorized users._ +### -AllowAutoAttendantHolidayRoutingChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. ```yaml Type: Boolean @@ -190,9 +187,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursRoutingChange +### -AllowAutoAttendantHolidaysChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. ```yaml Type: Boolean @@ -206,9 +203,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursRoutingChange +### -AllowAutoAttendantLanguageChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. ```yaml Type: Boolean @@ -222,9 +221,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidayRoutingChange +### -AllowAutoAttendantTimeZoneChange -When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. ```yaml Type: Boolean @@ -238,9 +239,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange +### -AllowCallQueueAgentOptChange -When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. ```yaml Type: Boolean @@ -254,9 +255,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMusicOnHoldChange +### -AllowCallQueueConferenceModeChange -When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. ```yaml Type: Boolean @@ -270,9 +271,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowSharedVoicemailGreetingChange +### -AllowCallQueueLanguageChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. ```yaml Type: Boolean @@ -286,9 +289,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutSharedVoicemailGreetingChange +### -AllowCallQueueMembershipChange -When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. ```yaml Type: Boolean @@ -302,11 +305,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentSharedVoicemailGreetingChange - -_This feature is not currently available to authorized users._ +### -AllowCallQueueMusicOnHoldChange -When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -320,11 +321,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange _This feature is not currently available to authorized users._ -When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. +When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. ```yaml Type: Boolean @@ -338,9 +339,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMembershipChange +### -AllowCallQueueNoAgentsRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. ```yaml Type: Boolean @@ -354,9 +355,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +### -AllowCallQueueOptOutChange -When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. ```yaml Type: Boolean @@ -370,9 +371,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueRoutingMethodChange +### -AllowCallQueueOverflowRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. ```yaml Type: Boolean @@ -386,9 +387,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueuePresenceBasedRoutingChange +### -AllowCallQueueOverflowSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -402,9 +403,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOptOutChange +### -AllowCallQueuePresenceBasedRoutingChange -When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. +When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. ```yaml Type: Boolean @@ -418,9 +419,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowRoutingChange +### -AllowCallQueueRoutingMethodChange -When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. ```yaml Type: Boolean @@ -450,9 +451,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentsRoutingChange +### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -466,9 +467,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueAgentOptChange +### -AllowCallQueueWelcomeGreetingChange -When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -530,16 +531,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAutoAttendantMetricsPermission +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalAgentMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` will not be able to access real-time metrics. +When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. ```yaml Type: Object @@ -554,16 +570,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeCallQueueMetricsPermission +### -HistoricalAutoAttendantMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` will not be able to access real-time metrics. +When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. ```yaml Type: Object @@ -578,16 +593,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RealTimeAgentMetricsPermission +### -HistoricalCallQueueMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. -When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. -> [!IMPORTANT] -> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` will not be able to access real-time metrics. +When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. ```yaml Type: Object @@ -602,38 +616,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalAutoAttendantMetricsPermission +### -Identity -PARAMVALUE: Disabled | AuthorizedOnly | All +Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: -When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. +-Identity global -When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. +To refer to a per-user policy, use syntax similar to this: -When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. +-Identity "SDA-Allow-All" + +If you do not specify an Identity, then the `Set-CsTeamsVoiceApplicationsPolicy` cmdlet will modify the global policy. ```yaml -Type: Object -Parameter Sets: Dual +Type: String +Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalCallQueueMetricsPermission +### -RealTimeAgentMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. -When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. -When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` will not be able to access real-time metrics. ```yaml Type: Object @@ -648,15 +664,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HistoricalAgentMetricsPermission +### -RealTimeAutoAttendantMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All -When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. -When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. -When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` will not be able to access real-time metrics. ```yaml Type: Object @@ -671,25 +688,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity - -Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: +### -RealTimeCallQueueMetricsPermission --Identity global +PARAMVALUE: Disabled | AuthorizedOnly | All -To refer to a per-user policy, use syntax similar to this: +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. --Identity "SDA-Allow-All" +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. -If you do not specify an Identity, then the `Set-CsTeamsVoiceApplicationsPolicy` cmdlet will modify the global policy. +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` will not be able to access real-time metrics. ```yaml -Type: String -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -712,22 +729,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLoadPolicy.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLoadPolicy.md index 1db49482a3..bbd2ab71a8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLoadPolicy.md @@ -1,239 +1,240 @@ ---- -external help file: MicrosoftTeams-help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy -title: Set-CsTeamsWorkLoadPolicy -schema: 2.0.0 ---- - -# Set-CsTeamsWorkLoadPolicy - -## SYNOPSIS - -This cmdlet sets the Teams Workload Policy value for current tenant. - -## SYNTAX - -```powershell -Set-CsTeamsWorkLoadPolicy [-AllowCalling ] [-AllowCallingPinned ] [-AllowMeeting ] - [-AllowMeetingPinned ] [-AllowMessaging ] [-AllowMessagingPinned ] - [-Description ] [[-Identity] ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsWorkLoadPolicy -Identity Global -AllowCalling Disabled -``` - -This sets the Teams Workload Policy Global value of AllowCalling to disabled. - -## PARAMETERS - -### -AllowCalling - -Determines if calling workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallingPinned - -Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeeting - -Determines if meetings workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetingPinned - -Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessaging - -Determines if messaging workload is enabled in the Teams App. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMessagingPinned - -Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -The description of the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -The identity of the Teams Work Load Policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsftInternalProcessingMode - -For internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) - -[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) - -[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) - -[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) +--- +external help file: MicrosoftTeams-help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy +schema: 2.0.0 +title: Set-CsTeamsWorkLoadPolicy +--- + +# Set-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet sets the Teams Workload Policy value for current tenant. + +## SYNTAX + +```powershell +Set-CsTeamsWorkLoadPolicy [-AllowCalling ] [-AllowCallingPinned ] [-AllowMeeting ] + [-AllowMeetingPinned ] [-AllowMessaging ] [-AllowMessagingPinned ] + [-Description ] [[-Identity] ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsWorkLoadPolicy -Identity Global -AllowCalling Disabled +``` + +This sets the Teams Workload Policy Global value of AllowCalling to disabled. + +## PARAMETERS + +### -AllowCalling + +Determines if calling workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallingPinned + +Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeeting + +Determines if meetings workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingPinned + +Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessaging + +Determines if messaging workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessagingPinned + +Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +The description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Teams Work Load Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLocationDetectionPolicy.md similarity index 99% rename from teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLocationDetectionPolicy.md index 176485db17..3dcb93c4ca 100644 --- a/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTeamsWorkLocationDetectionPolicy.md @@ -1,12 +1,13 @@ --- +author: artemiykozlov external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +manager: prashibadkur Module Name: MicrosoftTeams +ms.author: arkozlov online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy -title: Set-CsTeamsWorkLocationDetectionPolicy schema: 2.0.0 -author: artemiykozlov -ms.author: arkozlov -manager: prashibadkur +title: Set-CsTeamsWorkLocationDetectionPolicy --- # Set-CsTeamsWorkLocationDetectionPolicy diff --git a/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers.md index 616604a4f9..8857e1c9b1 100644 --- a/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantBlockedCallingNumbers.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantblockedcallingnumbers applicable: Microsoft Teams -title: Set-CsTenantBlockedCallingNumbers -schema: 2.0.0 author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: roykuntz +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantblockedcallingnumbers +schema: 2.0.0 +title: Set-CsTenantBlockedCallingNumbers --- # Set-CsTenantBlockedCallingNumbers @@ -45,28 +47,28 @@ To get the current tenant blocked calling numbers setting, use Get-CsTenantBlock ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTenantBlockedCallingNumbers -Enabled $false ``` This example turns off the tenant blocked calling numbers setting. No inbound number will be blocked from this feature. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsTenantBlockedCallingNumbers -Enabled $true ``` This example turns on the tenant blocked calling numbers setting. Inbound calls will be blocked based on the list of blocked number patterns. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsTenantBlockedCallingNumbers -Name "MyCustomBlockedCallingNumbersName" ``` This example renames the current blocked calling numbers with "MyCustomBlockedCallingNumbersName". No change is made besides the Name field change. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsTenantBlockedCallingNumbers -InboundBlockedNumberPatterns @((New-CsInboundBlockedNumberPattern -Name "AnonymousBlockedPattern" -Enabled $true -Pattern "^(?!)Anonymous")) ``` @@ -77,21 +79,6 @@ Note that if the current InboundBlockedNumberPatterns already contains a list of ## PARAMETERS -### -Identity -The Identity parameter is a unique identifier which identifies the TenantBlockedCallingNumbers to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -137,6 +124,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +The Identity parameter is a unique identifier which identifies the TenantBlockedCallingNumbers to set. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InboundBlockedNumberPatterns The InboundBlockedNumberPatterns parameter contains the list of InboundBlockedNumberPatterns. diff --git a/teams/teams-ps/teams/Set-CsTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantDialPlan.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantDialPlan.md index 1df48b83dc..6e1bf932fb 100644 --- a/teams/teams-ps/teams/Set-CsTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan applicable: Microsoft Teams -title: Set-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan +schema: 2.0.0 +title: Set-CsTenantDialPlan --- # Set-CsTenantDialPlan @@ -67,13 +68,15 @@ Finally, we pass the variable back to the NormalizationRules parameter of the `S ## PARAMETERS ### -Confirm + +> Applicable: Microsoft Teams + The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Microsoft Teams + The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. Maximum characters is 1040. @@ -90,7 +96,6 @@ Maximum characters is 1040. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Microsoft Teams + The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: 1 @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -NormalizationRules + +> Applicable: Microsoft Teams + The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet, which creates the rule and assigns it to the specified tenant dial plan. @@ -125,7 +135,6 @@ The number of normalization rules cannot exceed 50 per TenantDialPlan. Type: List Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -SimpleName + +> Applicable: Microsoft Teams + The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. This string can be up to 49 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), and parentheses (()). @@ -143,7 +155,6 @@ This string can be up to 49 characters long. Valid characters are alphabetic or Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -153,13 +164,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams + The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantFederationConfiguration.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantFederationConfiguration.md index c881b93707..d1e78b185f 100644 --- a/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantFederationConfiguration.md @@ -1,24 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration applicable: Microsoft Teams -title: Set-CsTenantFederationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau -ms.reviewer: williamlooney ms.date: 12/11/2024 +ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration +schema: 2.0.0 +title: Set-CsTenantFederationConfiguration --- # Set-CsTenantFederationConfiguration ## SYNOPSIS -> [!NOTE] -> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter AllowPublicUsers can no longer be used. - Manages federation configuration settings for your Skype for Business Online tenants. -These settings are used to determine which domains (if any) your users are allowed to communicate with. ## SYNTAX @@ -43,6 +41,9 @@ Set-CsTenantFederationConfiguration [-Tenant ] [-AllowedDomains [!NOTE] +> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter AllowPublicUsers can no longer be used. + Federation is a service that enables users to exchange IM and presence information with users from other domains. With Skype for Business Online, administrators can use the federation configuration settings to govern: @@ -56,7 +57,7 @@ However, administrators must use the `Set-CsTenantPublicProvider` cmdlet in orde ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -70,7 +71,7 @@ This domain object is stored in a variable named $x. The second command in the example then uses the `Set-CsTenantFederationConfiguration` cmdlet to update the blocked domains list. Using the Replace method ensures that the existing blocked domains list will be replaced by the new list: a list that contains only the domain fabrikam.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -83,7 +84,7 @@ The resulting domain object is then stored in a variable named $x. The second command in the example then uses the `Set-CsTenantFederationConfiguration` cmdlet and the Remove method to remove fabrikam.com from the blocked domains list for the specified tenant. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -96,7 +97,7 @@ This object is stored in a variable named $x. After the domain object has been created, the second command then uses the `Set-CsTenantFederationConfiguration` cmdlet and the Add method to add fabrikam.com to any domains already on the blocked domains list. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Set-CsTenantFederationConfiguration -BlockedDomains $Null ``` @@ -105,7 +106,7 @@ Example 5 shows how you can remove all the domains assigned to the blocked domai To do this, simply include the BlockedDomains parameter and set the parameter value to null ($Null). When this command completes, the blocked domain list will be cleared. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -117,7 +118,7 @@ Example 6 shows how you can replace domains in the Allowed Domains using a List First, a List collection is created and domains are added to it, then, simply include the AllowedDomainsAsAList parameter and set the parameter value to the List object. When this command completes, the allowed domains list will be replaced with those domains. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -128,7 +129,7 @@ Set-CsTenantFederationConfiguration -AllowedDomainsAsAList @{Add=$list} Example 7 shows how you can add domains to the existing Allowed Domains using a List object. First, a List is created and domains are added to it, then use the Add method in the AllowedDomainsAsAList parameter to add the domains to the existing allowed domains list. When this command completes, the domains in the list will be added to any domains already on the AllowedDomains list. -### -------------------------- Example 8 -------------------------- +### Example 8 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -139,14 +140,14 @@ Set-CsTenantFederationConfiguration -AllowedDomainsAsAList @{Remove=$list} Example 8 shows how you can remove domains from the existing Allowed Domains using a List object. First, a List is created and domains are added to it, then use the Remove method in the AllowedDomainsAsAList parameter to remove the domains from the existing allowed domains list. When this command completes, the domains in the list will be removed from the AllowedDomains list. -### -------------------------- Example 9 -------------------------- +### Example 9 ``` Set-CsTenantFederationConfiguration -AllowTeamsConsumer $True -AllowTeamsConsumerInbound $False ``` The command shown in Example 9 enables communication with people using Teams with an account that's not managed by an organization, to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people in your organization. -### -------------------------- Example 10 ------------------------- +### Example 10 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -162,14 +163,14 @@ When the BlockAllSubdomains is enabled, all users from all subdomains of all dom So, users from subdomain.contoso.com and subdomain.fabrikam.com will be blocked. Note: Users from subcontoso.com will not be blocked because it's a completely different domain rather than a subdomain of contoso.com. -### -------------------------- Example 11 ------------------------- +### Example 11 ``` Set-CsTenantFederationConfiguration -ExternalAccessWithTrialTenants "Allowed" ``` Example 11 shows how you can allow users to communicate with users in tenants that contain only trial licenses (default value is Blocked). -### -------------------------- Example 12 -------------------------- +### Example 12 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -182,7 +183,7 @@ Using the `AllowedTrialTenantDomains` parameter, you can whitelist specific "tri First, a List collection is created and domains are added to it, then, simply include the `AllowedTrialTenantDomains` parameter and set the parameter value to the List object. When this command completes, the Allowed Trial Tenant Domains list will be replaced with those domains. -### -------------------------- Example 13 -------------------------- +### Example 13 ``` Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @("contoso.com", "fabrikam.com") ``` @@ -191,7 +192,7 @@ Example 13 shows another way to set a value of `AllowedTrialTenantDomains`. It u The array of `AllowedTrialTenantDomains` can be emptied by running the following command: `Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @()`. -### -------------------------- Example 14 -------------------------- +### Example 14 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -203,7 +204,7 @@ Example 14 shows how you can add domains to the existing Allowed Trial Tenant Do First, a List is created and domains are added to it, then, use the Add method in the `AllowedTrialTenantDomains` parameter to add the domains to the existing allowed domains list. When this command completes, the domains in the list will be added to any domains already on the Allowed Trial Tenant Domains list. -### -------------------------- Example 15 -------------------------- +### Example 15 ``` $list = New-Object Collections.Generic.List[String] $list.add("contoso.com") @@ -215,7 +216,7 @@ Example 15 shows how you can remove domains from the existing Allowed Trial Tena First, a List is created and domains are added to it, then use the Remove method in the `AllowedTrialTenantDomains` parameter to remove the domains from the existing allowed domains list. When this command completes, the domains in the list will be removed from the Allowed Trial Tenant Domains list. -### -------------------------- Example 16 ------------------------- +### Example 16 ``` Set-CsTenantFederationConfiguration -DomainBlockingForMDOAdminsInTeams "Enabled" ``` @@ -245,12 +246,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowFederatedUsers -When set to True (the default value) users will be potentially allowed to communicate with users from other domains. -If this property is set to False then users cannot communicate with users from other domains regardless of the values assigned to the AllowedDomains and BlockedDomains properties. +### -AllowedDomainsAsAList +You can specify allowed domains using a List object that contains the domains that users are allowed to communicate with. See Examples section. ```yaml -Type: Boolean +Type: List Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -262,23 +262,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTeamsConsumer -Allows federation with people using Teams with an account that's not managed by an organization. +### -AllowedTrialTenantDomains +You can whitelist specific "trial-only" tenant domains, while keeping the `ExternalAccessWithTrialTenants` set to `Blocked`. This will allow you to protect your organization against majority of tenants that don't have any paid subscriptions, while still being able to collaborate externally with those trusted trial-tenants in the list. + +Note: +- The list supports up to maximum 4k domains. +- If `ExternalAccessWithTrialTenants` is set to `Allowed`, then the `AllowedTrialTenantDomains` list will not be checked. +- Any domain in this list that belongs to a tenant with paid subscriptions will be ignored. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFederatedUsers +When set to True (the default value) users will be potentially allowed to communicate with users from other domains. +If this property is set to False then users cannot communicate with users from other domains regardless of the values assigned to the AllowedDomains and BlockedDomains properties. ```yaml Type: Boolean Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTeamsConsumerInbound -Allows people using Teams with an account that's not managed by an organization, to discover and start communication with users in your organization. When -AllowTeamsConsumer is enabled and this parameter is disabled, only the users in your organization will be able to discover and start communication with people using Teams with an account that's not managed by an organization, but they will not discover and start communications with users in your organization. +### -AllowTeamsConsumer +Allows federation with people using Teams with an account that's not managed by an organization. ```yaml Type: Boolean @@ -292,25 +315,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockedDomains -If the AllowedDomains property has been set to AllowAllKnownDomains, then users will be allowed to communicate with users from any domain except domains that appear in the blocked domains list. -If the AllowedDomains property has not been set to AllowAllKnownDomains, then the blocked list is ignored, and users can only communicate with domains that have been expressly added to the allowed domains list. -The BlockedDomains parameter can support up to 4,000 domains. +### -AllowTeamsConsumerInbound +Allows people using Teams with an account that's not managed by an organization, to discover and start communication with users in your organization. When -AllowTeamsConsumer is enabled and this parameter is disabled, only the users in your organization will be able to discover and start communication with people using Teams with an account that's not managed by an organization, but they will not discover and start communications with users in your organization. ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### -BlockAllSubdomains + +> Applicable: Skype for Business Online + If the BlockedDomains parameter is used, then BlockAllSubdomains can be used to activate all subdomains blocking. If the BlockedDomains parameter is ignored, then BlockAllSubdomains is also ignored. Just like for BlockedDomains, users will be disallowed from communicating with users from blocked domains. @@ -320,7 +343,6 @@ But all subdomains for domains in this list will also be blocked. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -329,13 +351,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -BlockedDomains +If the AllowedDomains property has been set to AllowAllKnownDomains, then users will be allowed to communicate with users from any domain except domains that appear in the blocked domains list. +If the AllowedDomains property has not been set to AllowAllKnownDomains, then the blocked list is ignored, and users can only communicate with domains that have been expressly added to the allowed domains list. +The BlockedDomains parameter can support up to 4,000 domains. ```yaml -Type: SwitchParameter +Type: List Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams Required: False @@ -345,13 +369,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Confirm +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False @@ -361,35 +385,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the collection of tenant federation configuration settings to be modified. -Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the `Set-CsTenantFederationConfiguration` cmdlet. -If you do choose to use the Identity parameter you must also include the Tenant parameter. -For example: +### -DomainBlockingForMDOAdminsInTeams -`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` +> Applicable: Microsoft Teams + +When set to 'Enabled', security operations team will be able to add domains to the blocklist on security portal. +When set to 'Disabled', security operations team will not have permissions to update the domains blocklist. ```yaml -Type: XdsIdentity +Type: DomainBlockingForMDOAdminsInTeamsType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -ExternalAccessWithTrialTenants + +> Applicable: Microsoft Teams + +When set to 'Blocked', all external access with users from Teams subscriptions that contain only trial licenses will be blocked. This means users from these trial-only tenants will not be able to reach to your users via chats, Teams calls, and meetings (using the users authenticated identity) and your users will not be able to reach users in these trial-only tenants. If this setting is set to "Blocked", users from the trial-only tenant will also be removed from existing chats. + +Allowed - Communication with other tenants is allowed based on other settings. + +Blocked - Communication with users in tenants that contain only trial licenses will be blocked. ```yaml -Type: PSObject +Type: ExternalAccessWithTrialTenantsType Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -398,12 +426,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharedSipAddressSpace -When set to True, indicates that the users homed on Skype for Business Online use the same SIP domain as users homed on the on-premises version of Skype for Business Server. -The default value is False, meaning that the two sets of users have different SIP domains. +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -415,40 +442,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose federation settings are being modified. +### -Identity +Specifies the collection of tenant federation configuration settings to be modified. +Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the `Set-CsTenantFederationConfiguration` cmdlet. +If you do choose to use the Identity parameter you must also include the Tenant parameter. For example: -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. +`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` ```yaml -Type: Guid +Type: XdsIdentity Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TreatDiscoveredPartnersAsUnverified -When set to True, messages sent from discovered partners are considered unverified. -That means that those messages will be delivered only if they were sent from a person who is on the recipient's Contacts list. -The default value is False ($False). +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean +Type: PSObject Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -460,14 +479,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedDomainsAsAList -You can specify allowed domains using a List object that contains the domains that users are allowed to communicate with. See Examples section. +### -RestrictTeamsConsumerToExternalUserProfiles +Defines if a user is restricted to collaboration with Teams Consumer (TFL) user only in Extended Directory. +Possible values: True, False ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: -applicable: Microsoft Teams Required: False Position: Named @@ -476,18 +495,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalAccessWithTrialTenants -When set to 'Blocked', all external access with users from Teams subscriptions that contain only trial licenses will be blocked. This means users from these trial-only tenants will not be able to reach to your users via chats, Teams calls, and meetings (using the users authenticated identity) and your users will not be able to reach users in these trial-only tenants. If this setting is set to "Blocked", users from the trial-only tenant will also be removed from existing chats. - -Allowed - Communication with other tenants is allowed based on other settings. - -Blocked - Communication with users in tenants that contain only trial licenses will be blocked. +### -SharedSipAddressSpace +When set to True, indicates that the users homed on Skype for Business Online use the same SIP domain as users homed on the on-premises version of Skype for Business Server. +The default value is False, meaning that the two sets of users have different SIP domains. ```yaml -Type: ExternalAccessWithTrialTenantsType +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams +applicable: Microsoft Teams Required: False Position: Named @@ -496,33 +512,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainBlockingForMDOAdminsInTeams -When set to 'Enabled', security operations team will be able to add domains to the blocklist on security portal. -When set to 'Disabled', security operations team will not have permissions to update the domains blocklist. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose federation settings are being modified. +For example: -```yaml -Type: DomainBlockingForMDOAdminsInTeamsType -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +You can return your tenant ID by running this command: -### -AllowedTrialTenantDomains -You can whitelist specific "trial-only" tenant domains, while keeping the `ExternalAccessWithTrialTenants` set to `Blocked`. This will allow you to protect your organization against majority of tenants that don't have any paid subscriptions, while still being able to collaborate externally with those trusted trial-tenants in the list. +`Get-CsTenant | Select-Object DisplayName, TenantID` -Note: -- The list supports up to maximum 4k domains. -- If `ExternalAccessWithTrialTenants` is set to `Allowed`, then the `AllowedTrialTenantDomains` list will not be checked. -- Any domain in this list that belongs to a tenant with paid subscriptions will be ignored. +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: List +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -534,14 +539,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RestrictTeamsConsumerToExternalUserProfiles -Defines if a user is restricted to collaboration with Teams Consumer (TFL) user only in Extended Directory. -Possible values: True, False +### -TreatDiscoveredPartnersAsUnverified +When set to True, messages sent from discovered partners are considered unverified. +That means that those messages will be delivered only if they were sent from a person who is on the recipient's Contacts list. +The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: +applicable: Microsoft Teams Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantMigrationConfiguration.md similarity index 98% rename from teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantMigrationConfiguration.md index 9008b4da94..442a2ff544 100644 --- a/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantMigrationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration applicable: Microsoft Teams -title: Set-CsTenantMigrationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration +schema: 2.0.0 +title: Set-CsTenantMigrationConfiguration --- # Set-CsTenantMigrationConfiguration @@ -45,7 +47,7 @@ For more information, see [Using the Meeting Migration Service (MMS)](https://le ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTenantMigrationConfiguration -MeetingMigrationEnabled $false ``` @@ -54,29 +56,28 @@ This example disables MMS in the organization. ## PARAMETERS -### -Identity -Unique identifier for the Migration Configuration. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. -You can retrieve this object reference by calling the `Get-CsTenantMigrationConfiguration` cmdlet. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: SwitchParameter +Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -87,28 +88,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the Migration Configuration. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: String +Parameter Sets: Identity +Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Instance +The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. +You can retrieve this object reference by calling the `Get-CsTenantMigrationConfiguration` cmdlet. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: applicable: Microsoft Teams diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkRegion.md similarity index 97% rename from teams/teams-ps/teams/Set-CsTenantNetworkRegion.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkRegion.md index 7ec40da511..f737c0315c 100644 --- a/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkRegion.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion applicable: Microsoft Teams -title: Set-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion +schema: 2.0.0 +title: Set-CsTenantNetworkRegion --- # Set-CsTenantNetworkRegion ## SYNOPSIS -As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. +Changes the definintion of network regions. ## SYNTAX @@ -24,6 +25,8 @@ Set-CsTenantNetworkRegion [[-Identity] ] [-CentralSite ] [-Descr ``` ## DESCRIPTION +As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. + Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. ## EXAMPLES @@ -37,12 +40,12 @@ The command shown in Example 1 sets the network region 'RegionA' with the descri ## PARAMETERS -### -Identity -Unique identifier for the network region to be set. +### -CentralSite +This parameter is not used. ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: (All) Aliases: Required: False @@ -52,13 +55,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CentralSite -This parameter is not used. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -82,12 +85,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -The name of the network region. Not required in this PowerShell command. +### -Identity +Unique identifier for the network region to be set. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Required: False @@ -97,13 +100,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkRegionID +The name of the network region. Not required in this PowerShell command. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkSite.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSite.md similarity index 95% rename from teams/teams-ps/teams/Set-CsTenantNetworkSite.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSite.md index 9f97f7495e..706fe1545d 100644 --- a/teams/teams-ps/teams/Set-CsTenantNetworkSite.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSite.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite applicable: Microsoft Teams -title: Set-CsTenantNetworkSite -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite +schema: 2.0.0 +title: Set-CsTenantNetworkSite --- # Set-CsTenantNetworkSite ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, Set-CsTenantNetworkSite to define network sites. Network sites are defined as a collection of IP subnets. Each network site must be associated with a network region. Tenant network site is used for Location Based Routing. +Changes the definition of network sites. ## SYNTAX @@ -56,13 +57,13 @@ The command shown in Example 3 sets the network site 'site3' with description 's ## PARAMETERS -### -Identity -Unique identifier for the network site to be set. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -131,8 +132,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationPolicy -This parameter is reserved for internal Microsoft use. +### -Identity +Unique identifier for the network site to be set. ```yaml Type: String @@ -146,8 +147,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -NetworkRegionID is the identifier for the network region which the current network site is associating to. +### -LocationPolicy +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -161,8 +162,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRoamingPolicy -NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. +### -NetworkRegionID +NetworkRegionID is the identifier for the network region which the current network site is associating to. ```yaml Type: String @@ -176,13 +177,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkRoamingPolicy +NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSubnet.md similarity index 94% rename from teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSubnet.md index 52e3aea595..4c8315e3ab 100644 --- a/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantNetworkSubnet.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet applicable: Microsoft Teams -title: Set-CsTenantNetworkSubnet -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet +schema: 2.0.0 +title: Set-CsTenantNetworkSubnet --- # Set-CsTenantNetworkSubnet ## SYNOPSIS -As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkSubnet to define network subnets and assign them to network sites. Each internal subnet may only be associated with one site. The organization's network subnet is used for Location-Based Routing. +Changes the definition of network subnets. ## SYNTAX @@ -48,16 +49,16 @@ IPv6 format subnet accepts maskbits from 0 to 128 inclusive. ## PARAMETERS -### -Identity -Unique identifier for the network subnet to be set. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String -Parameter Sets: Identity -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -78,28 +79,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaskBits -This parameter determines the length of bits to mask to the subnet. - -IPv4 format subnet accepts maskbits from 0 to 32 inclusive. IPv6 format subnet accepts maskbits from 0 to 128 inclusive. +### -Identity +Unique identifier for the network subnet to be set. ```yaml -Type: Int32 -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID -NetworkSiteID is the identifier for the network site which the current network subnet is associating to. +### -MaskBits +This parameter determines the length of bits to mask to the subnet. + +IPv4 format subnet accepts maskbits from 0 to 32 inclusive. IPv6 format subnet accepts maskbits from 0 to 128 inclusive. ```yaml -Type: String +Type: Int32 Parameter Sets: (All) Aliases: @@ -110,13 +111,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -NetworkSiteID +NetworkSiteID is the identifier for the network site which the current network subnet is associating to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md b/teams/teams-ps/MicrosoftTeams/Set-CsTenantTrustedIPAddress.md similarity index 96% rename from teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md rename to teams/teams-ps/MicrosoftTeams/Set-CsTenantTrustedIPAddress.md index 8e93bf341c..80b8718799 100644 --- a/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsTenantTrustedIPAddress.md @@ -1,19 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-cstenanttrustedipaddress applicable: Microsoft Teams -title: Set-CsTenantTrustedIPAddress -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenanttrustedipaddress +schema: 2.0.0 +title: Set-CsTenantTrustedIPAddress --- # Set-CsTenantTrustedIPAddress ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, Set-CsTenantTrustedIPAddress to define external subnets and assign them to the tenant. You can define an unlimited number of external subnets for a tenant. +Changes the definition of network IP addresses. ## SYNTAX diff --git a/teams/teams-ps/teams/Set-CsUser.md b/teams/teams-ps/MicrosoftTeams/Set-CsUser.md similarity index 89% rename from teams/teams-ps/teams/Set-CsUser.md rename to teams/teams-ps/MicrosoftTeams/Set-CsUser.md index 97f1298690..2f94447b63 100644 --- a/teams/teams-ps/teams/Set-CsUser.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsUser.md @@ -1,23 +1,21 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csuser applicable: Microsoft Teams -title: Set-CsUser -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/teams/set-csuser +schema: 2.0.0 +title: Set-CsUser --- # Set-CsUser ## SYNOPSIS Modifies Skype for Business properties for an existing user account. -Properties can be modified only for accounts that have been enabled for use with Skype for Business. -This cmdlet was introduced in Lync Server 2010. - -**Note**: Using this cmdlet for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. ## SYNTAX @@ -31,6 +29,11 @@ Set-CsUser [-DomainController ] [-Identity] [-PassThru] ``` ## DESCRIPTION +Properties can be modified only for accounts that have been enabled for use with Skype for Business. +This cmdlet was introduced in Lync Server 2010. + +**Note**: Using this cmdlet for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. + The `Set-CsUser` cmdlet enables you to modify the Skype for Business related user account attributes that are stored in Active Directory Domain Services or modify a subset of Skype for Business online user attributes that are stored in Microsoft Entra ID. For example, you can disable or re-enable a user for Skype for Business Server; enable or disable a user for audio/video (A/V) communications; or modify a user's private line and line URI numbers. For Skype for Business online enable or disable a user for enterprise voice, hosted voicemail, or modify the user's on premise line uri. The `Set-CsUser` cmdlet can be used only for users who have been enabled for Skype for Business. @@ -42,7 +45,7 @@ You should not attempt to manually configure these attributes. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Set-CsUser -Identity "Pilar Ackerman" -EnterpriseVoiceEnabled $True ``` @@ -51,7 +54,7 @@ In Example 1, the `Set-CsUser` cmdlet is used to modify the user account with th In this case, the account is modified to enable Enterprise Voice, the Microsoft implementation of VoIP. This task is carried out by adding the EnterpriseVoiceEnabled parameter, and then setting the parameter value to $True. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsUser -LdapFilter "Department=Finance" | Set-CsUser -EnterpriseVoiceEnabled $True ``` @@ -60,7 +63,7 @@ In Example 2, all the users in the Finance department have their accounts enable In this command, the `Get-CsUser` cmdlet and the LdapFilter parameter are first used to return a collection of all the users who work in the Finance department. That information is then piped to the `Set-CsUser` cmdlet, which enables Enterprise Voice for each account in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell Set-CsUser -Identity "Pilar Ackerman" -LineUri "tel:+123456789" ``` @@ -70,28 +73,29 @@ In this case, the account is modified to set the phone number assigned to the us ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be modified. -User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). -User Identities can also be referenced by using the user's Active Directory distinguished name. +### -AcpInfo -You can use the asterisk (*) wildcard character when using the display name as the user Identity. -For example, the Identity "Smith" returns all the users who have a display name that ends with the string value " Smith". +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to assign one or more third-party audio conferencing providers to a user. +However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. ```yaml -Type: UserIdParameter +Type: AcpInfo Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -AudioVideoDisabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to make audio/visual (A/V) calls by using Skype for Business. If set to True, the user will largely be restricted to sending and receiving instant messages. @@ -103,7 +107,6 @@ You cannot disable A/V communications if a user is currently enabled for remote Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -112,20 +115,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Indicates whether or not the user has been enabled for Skype for Business Server. -If you set this value to False, the user will no longer be able to log on to Skype for Business Server; setting this value to True re-enables the user's logon privileges. +### -Confirm -If you disable an account by using the Enabled parameter, the information associated with that account (including assigned policies and whether or not the user is enabled for Enterprise Voice and/or remote call control) is retained. -If you later re-enable the account by using the Enabled parameter, the associated account information will be restored. -This differs from using the `Disable-CsUser` cmdlet to disable a user account. -When you run the `Disable-CsUser` cmdlet, all the Skype for Business Server data associated with that account is deleted. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -135,6 +134,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a domain controller to connect to when modifying a user account. If this parameter is not included then the cmdlet will use the first available domain controller. @@ -142,7 +144,6 @@ If this parameter is not included then the cmdlet will use the first available d Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -151,17 +152,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnterpriseVoiceEnabled -Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). -With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. +### -Enabled -**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the user has been enabled for Skype for Business Server. +If you set this value to False, the user will no longer be able to log on to Skype for Business Server; setting this value to True re-enables the user's logon privileges. + +If you disable an account by using the Enabled parameter, the information associated with that account (including assigned policies and whether or not the user is enabled for Enterprise Voice and/or remote call control) is retained. +If you later re-enable the account by using the Enabled parameter, the associated account information will be restored. +This differs from using the `Disable-CsUser` cmdlet to disable a user account. +When you run the `Disable-CsUser` cmdlet, all the Skype for Business Server data associated with that account is deleted. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: CsEnabled Required: False Position: Named @@ -170,17 +176,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostedVoiceMail -When set to True, enables a user's voice mail calls to be routed to a hosted version of Microsoft Exchange Server. -In addition, setting this option to True enables Skype for Business users to directly place a call to another user's voice mail. +### -EnterpriseVoiceEnabled -**Note**: It is not required to set this parameter for Microsoft Teams users. Using this parameter has been deprecated for Microsoft Teams users in commercial and GCC cloud instances. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). +With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. + +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -189,27 +197,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. +### -ExchangeArchivingPolicy -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and the "tel:" prefix, for example: tel:+14255551297. -Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not -be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 -routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call -directly to the user. +Indicates where the user's instant messaging sessions are archived. +Allowed values are: -For Direct Routing phone numbers in GCC High and DoD cloud instances, assigning a base phone number to a user or resource account is not supported if you already have other users or resource accounts assigned phone numbers with the same base phone number and extensions or vice versa. For instance, if you have a user with the assigned phone number +14255551200;ext=123 you can't assign the phone number +14255551200 to another user or resource account or if you have a user or resource account with the assigned phone number +14255551200 you can't assign the phone number +14255551200;ext=123 to another user or resource account. Assigning phone numbers with the same base number but different extensions to users and resource accounts is supported. For instance, you can have a user with +14255551200;ext=123 and another user with +14255551200;ext=124. +Uninitialized -Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving ```yaml -Type: String +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -218,16 +224,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineServerURI -The URI of the remote call control telephone gateway assigned to the user. -The LineServerUri is the gateway URI, prefaced by "sip:". -For example: sip:rccgateway@litwareinc.com +### -HostedVoiceMail + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, enables a user's voice mail calls to be routed to a hosted version of Microsoft Exchange Server. +In addition, setting this option to True enables Skype for Business users to directly place a call to another user's voice mail. + +**Note**: It is not required to set this parameter for Microsoft Teams users. Using this parameter has been deprecated for Microsoft Teams users in commercial and GCC cloud instances. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -236,43 +245,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrivateLine -Phone number for the user's private telephone line. -A private line is a phone number that is not published in Active Directory Domain Services and, as a result, is not readily available to other people. -In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. -Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. +### -Identity -The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. -For example: tel:+14255551297. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be modified. +User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the display name as the user Identity. +For example, the Identity "Smith" returns all the users who have a display name that ends with the string value " Smith". ```yaml -Type: String +Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -RemoteCallControlTelephonyEnabled -Indicates whether the user has been enabled for remote call control telephony. -When enabled for remote call control, a user can employ Skype for Business to answer phone calls made to his or her desk phone. -Phone calls can also be made using Skype for Business. -These calls all rely on the standard telephone network, also known as the public switched telephone network (PSTN). -To make and receive phone calls over the Internet, the user must be enabled for Enterprise Voice. -For details, see the parameter EnterpriseVoiceEnabled. +### -LineServerURI -To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The URI of the remote call control telephone gateway assigned to the user. +The LineServerUri is the gateway URI, prefaced by "sip:". +For example: sip:rccgateway@litwareinc.com ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -281,15 +288,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Skype for Business. -The SIP address must use the sip: prefix as well as a valid SIP domain; for example: `-SipAddress sip:kenmyer@litwareinc.com`. +### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. + +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and the "tel:" prefix, for example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. + +It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not +be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 +routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call +directly to the user. + +For Direct Routing phone numbers in GCC High and DoD cloud instances, assigning a base phone number to a user or resource account is not supported if you already have other users or resource accounts assigned phone numbers with the same base phone number and extensions or vice versa. For instance, if you have a user with the assigned phone number +14255551200;ext=123 you can't assign the phone number +14255551200 to another user or resource account or if you have a user or resource account with the assigned phone number +14255551200 you can't assign the phone number +14255551200;ext=123 to another user or resource account. Assigning phone numbers with the same base number but different extensions to users and resource accounts is supported. For instance, you can have a user with +14255551200;ext=123 and another user with +14255551200;ext=124. + +Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -298,17 +319,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user whose account is being modified. -By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. +### -OnPremLineURI +Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. +For example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. -**Note**: This parameter is not available for Teams Only tenants from version 3.0.0 onwards. +Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. +Depending on your setup, those two numbers could actually be different. +For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. +Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. + +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. + +**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +applicable: Microsoft Teams Required: False Position: Named @@ -317,14 +348,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user whose account is being modified. +By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. + +**Note**: This parameter is not available for Teams Only tenants from version 3.0.0 onwards. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,14 +369,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PrivateLine + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the user's private telephone line. +A private line is a phone number that is not published in Active Directory Domain Services and, as a result, is not readily available to other people. +In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. +Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. + +The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. +For example: tel:+14255551297. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -349,15 +393,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcpInfo -Enables you to assign one or more third-party audio conferencing providers to a user. -However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. +### -RemoteCallControlTelephonyEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the user has been enabled for remote call control telephony. +When enabled for remote call control, a user can employ Skype for Business to answer phone calls made to his or her desk phone. +Phone calls can also be made using Skype for Business. +These calls all rely on the standard telephone network, also known as the public switched telephone network (PSTN). +To make and receive phone calls over the Internet, the user must be enabled for Enterprise Voice. +For details, see the parameter EnterpriseVoiceEnabled. + +To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. ```yaml -Type: AcpInfo +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -366,23 +418,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the user's instant messaging sessions are archived. -Allowed values are: - -Uninitialized - -UseLyncArchivingPolicy +### -SipAddress -ArchivingToExchange +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -NoArchiving +Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Skype for Business. +The SIP address must use the sip: prefix as well as a valid SIP domain; for example: `-SipAddress sip:kenmyer@litwareinc.com`. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -391,27 +437,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnPremLineURI -Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. -For example: tel:+14255551297. -Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. - -Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. -Depending on your setup, those two numbers could actually be different. -For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. -Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. +### -WhatIf -**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Set-CsUserCallingDelegate.md b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingDelegate.md similarity index 95% rename from teams/teams-ps/teams/Set-CsUserCallingDelegate.md rename to teams/teams-ps/MicrosoftTeams/Set-CsUserCallingDelegate.md index ac17aa7a8a..ee85ec312d 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingDelegate.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingDelegate.md @@ -1,144 +1,143 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate -applicable: Microsoft Teams -title: Set-CsUserCallingDelegate -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsUserCallingDelegate - -## SYNOPSIS -This cmdlet will change permissions for a delegate for calling in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -```powershell -Set-CsUserCallingDelegate -Identity -Delegate [-MakeCalls ] [-ReceiveCalls ] [-ManageSettings ] [] -``` - -## DESCRIPTION -This cmdlet can change the permissions assigned to a delegate for the specified user. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $false -ReceiveCalls $true -ManageSettings $false -``` -This example shows setting the permissions for user1@contoso.com's delegate user2@contoso.com. - -### Example 2 -```powershell -Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true -``` -This example shows setting the MakeCalls permissions to True for user1@contoso.com's delegate user2@contoso.com. - -## PARAMETERS - -### -Delegate -The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. - -A user can have up to 25 delegates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MakeCalls - -Specifies whether delegate is allowed to make calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: False -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManageSettings - -Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: False -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveCalls - -Specifies whether delegate is allowed to receive calls on behalf of the specified user. - -```yaml -Type: System.Boolean -Parameter Sets: All -Aliases: - -Required: False -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, -and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -The specified user need to have the Microsoft Phone System license assigned. - -You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. - -## RELATED LINKS -[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate +schema: 2.0.0 +title: Set-CsUserCallingDelegate +--- + +# Set-CsUserCallingDelegate + +## SYNOPSIS +This cmdlet will change permissions for a delegate for calling in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsUserCallingDelegate -Identity -Delegate [-MakeCalls ] [-ReceiveCalls ] [-ManageSettings ] [] +``` + +## DESCRIPTION +This cmdlet can change the permissions assigned to a delegate for the specified user. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $false -ReceiveCalls $true -ManageSettings $false +``` +This example shows setting the permissions for user1@contoso.com's delegate user2@contoso.com. + +### Example 2 +```powershell +Set-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso.com -MakeCalls $true +``` +This example shows setting the MakeCalls permissions to True for user1@contoso.com's delegate user2@contoso.com. + +## PARAMETERS + +### -Delegate +The Identity of the delegate to add. Can be specified using the ObjectId or the SIP address. + +A user can have up to 25 delegates. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to add a delegate for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeCalls + +Specifies whether delegate is allowed to make calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: False +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageSettings + +Specifies whether delegate is allowed to change the delegate and calling settings for the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: False +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveCalls + +Specifies whether delegate is allowed to receive calls on behalf of the specified user. + +```yaml +Type: System.Boolean +Parameter Sets: All +Aliases: + +Required: False +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, +and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +The specified user need to have the Microsoft Phone System license assigned. + +You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. + +## RELATED LINKS +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Set-CsUserCallingSettings.md b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingSettings.md similarity index 97% rename from teams/teams-ps/teams/Set-CsUserCallingSettings.md rename to teams/teams-ps/MicrosoftTeams/Set-CsUserCallingSettings.md index 4b590f4ab2..ae2fe59c05 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsUserCallingSettings.md @@ -1,414 +1,413 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings -applicable: Microsoft Teams -title: Set-CsUserCallingSettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: ---- - -# Set-CsUserCallingSettings - -## SYNOPSIS -This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. - -## SYNTAX - -### Identity (Default) -```powershell -Set-CsUserCallingSettings -Identity [] -``` - -### ForwardingOnOff -```powershell -Set-CsUserCallingSettings -Identity -IsForwardingEnabled [] -``` - -### Forwarding -```powershell -Set-CsUserCallingSettings -Identity -IsForwardingEnabled -ForwardingType [-ForwardingTarget ] -ForwardingTargetType [] -``` - -### UnansweredOnOff -```powershell -Set-CsUserCallingSettings -Identity -IsUnansweredEnabled [] -``` - -### Unanswered -```powershell -Set-CsUserCallingSettings -Identity -IsUnansweredEnabled [-UnansweredTarget ] -UnansweredTargetType -UnansweredDelay [] -``` - -### CallGroup -```powershell -Set-CsUserCallingSettings -Identity -CallGroupOrder -CallGroupTargets [] -``` - -### CallGroupMembership -```powershell -Set-CsUserCallingSettings -Identity -GroupMembershipDetails [] -``` - -### CallGroupNotification -```powershell -Set-CsUserCallingSettings -Identity -GroupNotificationOverride [] -``` - -## DESCRIPTION -This cmdlet sets the call forwarding, simultaneous ringing and call group settings for the specified user. - -When specifying settings you need to specify all settings with a settings grouping, for instance, you can't just change a forwarding target. Instead, you need to -start by getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Voicemail -``` -This example shows setting immediate call forwarding to voicemail for user1@contoso.com. - -### Example 2 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $false -``` -This example shows removing call forwarding for user1@contoso.com. - -### Example 3 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Simultaneous -ForwardingTargetType SingleTarget -ForwardingTarget "+12065551234" -``` -This example shows setting simultaneous ringing to +12065551234 for user1@contoso.com. - -### Example 4 -```powershell -Set-CsUserCallingSettings -Identity user1@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType MyDelegates -UnansweredDelay 00:00:30 -``` -This example shows setting unanswered call forward to the delegates after 30 seconds for user1@contoso.com. - -### Example 5 -```powershell -$cgm = @("sip:user2@contoso.com","sip:user3@contoso.com") -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder InOrder -CallGroupTargets $cgm -Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Group -``` -This example shows creating a call group for user1@contoso.com with 2 members and setting immediate call forward to the call group for user1@contoso.com. - -### Example 6 -```powershell -$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com -$cgt = {$ucs.CallGroupTargets}.Invoke() -$cgt.Add("sip:user5@contoso.com") -$cgt.Remove("sip:user6@contoso.com") -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets $cgt - -$gmd = (Get-CsUserCallingSettings -Identity user5@contoso.com).GroupMembershipDetails -$gmd[[array]::IndexOf($gmd.CallGroupOwnerId,'sip:user1@contoso.com')].NotificationSetting = 'Banner' -Set-CsUserCallingSettings -Identity user5@contoso.com -GroupMembershipDetails $gmd -``` - -This example shows how to update the call group of user1@contoso.com to add user5@contoso.com and remove user6@contoso.com. In addition the notification setting for -user5@contoso.com for user1@contoso.com's call group is set to Banner. - -The key to note here is the call group membership is defined on the object of the owner of the call group, in the above case this is user1@contoso.com. However, -the notification setting for a member for a particular call group is defined on the member. In this case user5@contoso.com. - -### Example 7 -```powershell -$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com -Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets @() -``` - -This example shows how to remove all members of the call group. - -### Example 8 -```powershell -[Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[]]$gmd = @( - [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user20@contoso.com';NotificationSetting='Banner'} - [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user30@contoso.com';NotificationSetting='Mute'} -) -Set-CsUserCallingSettings -Identity user10@contoso.com -GroupMembershipDetails $gmd -``` - -In this example user10@contoso.com is a member of two call groups: user20@contoso.com and user30@contoso.com. User10@contoso.com would like to have Banner -notification for the first call group and Mute notification for the last one. - -### Example 9 -```powershell -Set-CsUserCallingSettings -Identity user2@contoso.com -GroupNotificationOverride 'Mute' -``` - -This example shows how to set the group notification override for user2@contoso.com. This setting overrides any specific notification setting set for the user -on any call group the user is a member of. - -### Example 10 -```powershell -Set-CsUserCallingSettings -Identity user6@contoso.com -IsForwardingEnabled $false -Set-CsUserCallingSettings -Identity user6@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType Voicemail -UnansweredDelay 00:00:20 -``` - -This example shows how to set the default call forwarding settings for a user. - -### Example 11 -```powershell -Set-CsUserCallingSettings -Identity user7@contoso.com -IsUnansweredEnabled $false -``` - -This example shows turning off unanswered call forwarding for a user. The Microsoft Teams client will show this as _If unanswered Do nothing_. - -## PARAMETERS - -### -CallGroupOrder - -The order in which to call members of the Call Group. The supported values are Simultaneous and InOrder. - -You can only use InOrder, if the call group has 5 or less members. - -```yaml -Type: System.String -Parameter Sets: (CallGroup) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallGroupTargets -The members of the Call Group. You need to always specify the full set of members as the parameter value. What you set here will overwrite the current call group membership. - -A call group can have up to 25 members. - -```yaml -Type: System.Array of System.String -Parameter Sets: (CallGroup) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingTarget - -The forwarding target. Supported types of values are ObjectId's, SIP addresses and phone numbers. -For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. - -Only used when ForwardingTargetType is SingleTarget. - -```yaml -Type: System.String -Parameter Sets: (Forwarding) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingTargetType - -The forwarding target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. Voicemail is only supported for Immediate forwarding. - -SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1 -delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). - -```yaml -Type: System.String -Parameter Sets: (Forwarding) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardingType - -The type of forwarding to set. Supported values are Immediate and Simultaneous - -```yaml -Type: System.String -Parameter Sets: (Forwarding) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupMembershipDetails - -The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a -call group and the notification setting for the specified user for that call group. - -This parameter only exists if the specified user is a member of a call group. You can't create it, you can only change it. - -You need to always specify the full group membership details as the parameter value. What you set here will over-write the current group membership details. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] -Parameter Sets: (GroupMembershipDetails) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -GroupNotificationOverride - -The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. - -The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. - -```yaml -Type: System.String -Parameter Sets: (GroupNotificationOverride) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsForwardingEnabled - -This parameter controls whether forwarding is enabled or not. - -```yaml -Type: System.Boolean -Parameter Sets: (ForwardingOnOff,Forwarding) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsUnansweredEnabled - -This parameter controls whether forwarding for unanswered calls is enabled or not. - -```yaml -Type: System.Boolean -Parameter Sets: (UnansweredOnOff,Unanswered) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnansweredDelay - -The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and -60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds. - -```yaml -Type: System.String -Parameter Sets: (Unanswered) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnansweredTarget - -The unanswered target. Supported type of values are ObjectId, SIP address and phone number. -For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. - -Only used when UnansweredTargetType is SingleTarget. - -```yaml -Type: System.String -Parameter Sets: (Unanswered) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnansweredTargetType - -The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. - -SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's -delegates. Group is used when forwarding the unanswered call to the specified user's call group. - -```yaml -Type: System.String -Parameter Sets: (Unanswered) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. - -The specified user need to have the Microsoft Phone System license assigned. - -When forwarding to MyDelegates, the specified user needs to have one or more delegates defined that are allowed to receive calls. When forwarding to Group, the -specified user needs to have one or more members of the user's call group. - -The cmdlet is validating the different settings and is always writing all the parameters in a settings group. You might see validation errors from the cmdlet due to -this behavior. As an example, if you have ForwardingTargetType set to Group and you want to remove all members of the call group, you will get a validation error. - -You can specify a SIP URI without 'sip:' on input, but the output from Get-CsUserCallingSettings will show the full SIP URI. - -You are not able to configure delegates via this cmdlet. Please use New-CsUserCallingDelegate, Set-CsUserCallingDelegate cmdlets and Remove-CsUserCallingDelegate. - -## RELATED LINKS -[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) - -[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) - -[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) - -[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) +--- +applicable: Microsoft Teams +author: serdarsoysal +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings +schema: 2.0.0 +title: Set-CsUserCallingSettings +--- + +# Set-CsUserCallingSettings + +## SYNOPSIS +This cmdlet will set the call forwarding, simultaneous ringing and call group settings for the specified user. + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsUserCallingSettings -Identity [] +``` + +### ForwardingOnOff +```powershell +Set-CsUserCallingSettings -Identity -IsForwardingEnabled [] +``` + +### Forwarding +```powershell +Set-CsUserCallingSettings -Identity -IsForwardingEnabled -ForwardingType [-ForwardingTarget ] -ForwardingTargetType [] +``` + +### UnansweredOnOff +```powershell +Set-CsUserCallingSettings -Identity -IsUnansweredEnabled [] +``` + +### Unanswered +```powershell +Set-CsUserCallingSettings -Identity -IsUnansweredEnabled [-UnansweredTarget ] -UnansweredTargetType -UnansweredDelay [] +``` + +### CallGroup +```powershell +Set-CsUserCallingSettings -Identity -CallGroupOrder -CallGroupTargets [] +``` + +### CallGroupMembership +```powershell +Set-CsUserCallingSettings -Identity -GroupMembershipDetails [] +``` + +### CallGroupNotification +```powershell +Set-CsUserCallingSettings -Identity -GroupNotificationOverride [] +``` + +## DESCRIPTION +This cmdlet sets the call forwarding, simultaneous ringing and call group settings for the specified user. + +When specifying settings you need to specify all settings with a settings grouping, for instance, you can't just change a forwarding target. Instead, you need to +start by getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Voicemail +``` +This example shows setting immediate call forwarding to voicemail for user1@contoso.com. + +### Example 2 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $false +``` +This example shows removing call forwarding for user1@contoso.com. + +### Example 3 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Simultaneous -ForwardingTargetType SingleTarget -ForwardingTarget "+12065551234" +``` +This example shows setting simultaneous ringing to +12065551234 for user1@contoso.com. + +### Example 4 +```powershell +Set-CsUserCallingSettings -Identity user1@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType MyDelegates -UnansweredDelay 00:00:30 +``` +This example shows setting unanswered call forward to the delegates after 30 seconds for user1@contoso.com. + +### Example 5 +```powershell +$cgm = @("sip:user2@contoso.com","sip:user3@contoso.com") +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder InOrder -CallGroupTargets $cgm +Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Group +``` +This example shows creating a call group for user1@contoso.com with 2 members and setting immediate call forward to the call group for user1@contoso.com. + +### Example 6 +```powershell +$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com +$cgt = {$ucs.CallGroupTargets}.Invoke() +$cgt.Add("sip:user5@contoso.com") +$cgt.Remove("sip:user6@contoso.com") +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets $cgt + +$gmd = (Get-CsUserCallingSettings -Identity user5@contoso.com).GroupMembershipDetails +$gmd[[array]::IndexOf($gmd.CallGroupOwnerId,'sip:user1@contoso.com')].NotificationSetting = 'Banner' +Set-CsUserCallingSettings -Identity user5@contoso.com -GroupMembershipDetails $gmd +``` + +This example shows how to update the call group of user1@contoso.com to add user5@contoso.com and remove user6@contoso.com. In addition the notification setting for +user5@contoso.com for user1@contoso.com's call group is set to Banner. + +The key to note here is the call group membership is defined on the object of the owner of the call group, in the above case this is user1@contoso.com. However, +the notification setting for a member for a particular call group is defined on the member. In this case user5@contoso.com. + +### Example 7 +```powershell +$ucs = Get-CsUserCallingSettings -Identity user1@contoso.com +Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder $ucs.CallGroupOrder -CallGroupTargets @() +``` + +This example shows how to remove all members of the call group. + +### Example 8 +```powershell +[Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[]]$gmd = @( + [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user20@contoso.com';NotificationSetting='Banner'} + [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user30@contoso.com';NotificationSetting='Mute'} +) +Set-CsUserCallingSettings -Identity user10@contoso.com -GroupMembershipDetails $gmd +``` + +In this example user10@contoso.com is a member of two call groups: user20@contoso.com and user30@contoso.com. User10@contoso.com would like to have Banner +notification for the first call group and Mute notification for the last one. + +### Example 9 +```powershell +Set-CsUserCallingSettings -Identity user2@contoso.com -GroupNotificationOverride 'Mute' +``` + +This example shows how to set the group notification override for user2@contoso.com. This setting overrides any specific notification setting set for the user +on any call group the user is a member of. + +### Example 10 +```powershell +Set-CsUserCallingSettings -Identity user6@contoso.com -IsForwardingEnabled $false +Set-CsUserCallingSettings -Identity user6@contoso.com -IsUnansweredEnabled $true -UnansweredTargetType Voicemail -UnansweredDelay 00:00:20 +``` + +This example shows how to set the default call forwarding settings for a user. + +### Example 11 +```powershell +Set-CsUserCallingSettings -Identity user7@contoso.com -IsUnansweredEnabled $false +``` + +This example shows turning off unanswered call forwarding for a user. The Microsoft Teams client will show this as _If unanswered Do nothing_. + +## PARAMETERS + +### -CallGroupOrder + +The order in which to call members of the Call Group. The supported values are Simultaneous and InOrder. + +You can only use InOrder, if the call group has 5 or less members. + +```yaml +Type: System.String +Parameter Sets: (CallGroup) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallGroupTargets +The members of the Call Group. You need to always specify the full set of members as the parameter value. What you set here will overwrite the current call group membership. + +A call group can have up to 25 members. + +```yaml +Type: System.Array of System.String +Parameter Sets: (CallGroup) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingTarget + +The forwarding target. Supported types of values are ObjectId's, SIP addresses and phone numbers. +For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. + +Only used when ForwardingTargetType is SingleTarget. + +```yaml +Type: System.String +Parameter Sets: (Forwarding) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingTargetType + +The forwarding target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. Voicemail is only supported for Immediate forwarding. + +SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1 +delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). + +```yaml +Type: System.String +Parameter Sets: (Forwarding) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForwardingType + +The type of forwarding to set. Supported values are Immediate and Simultaneous + +```yaml +Type: System.String +Parameter Sets: (Forwarding) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupMembershipDetails + +The group membership details for the specified user. It is an array of ICallGroupMembershipDetails, which is an object containing the identity of an owner of a +call group and the notification setting for the specified user for that call group. + +This parameter only exists if the specified user is a member of a call group. You can't create it, you can only change it. + +You need to always specify the full group membership details as the parameter value. What you set here will over-write the current group membership details. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] +Parameter Sets: (GroupMembershipDetails) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -GroupNotificationOverride + +The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. + +The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. + +```yaml +Type: System.String +Parameter Sets: (GroupNotificationOverride) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity of the user to set call forwarding, simultaneous ringing and call group settings for. Can be specified using the ObjectId or the SIP address. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsForwardingEnabled + +This parameter controls whether forwarding is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: (ForwardingOnOff,Forwarding) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUnansweredEnabled + +This parameter controls whether forwarding for unanswered calls is enabled or not. + +```yaml +Type: System.Boolean +Parameter Sets: (UnansweredOnOff,Unanswered) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredDelay + +The time the call will ring the user before it is forwarded to the unanswered target. The supported format is hh:mm:ss and the delay range needs to be between 10 and +60 seconds in 10 seconds increments, i.e. 00:00:10, 00:00:20, 00:00:30, 00:00:40, 00:00:50 and 00:01:00. The default value is 20 seconds. + +```yaml +Type: System.String +Parameter Sets: (Unanswered) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredTarget + +The unanswered target. Supported type of values are ObjectId, SIP address and phone number. +For phone numbers we support the following types of formats: E.164 (+12065551234 or +1206555000;ext=1234) or non-E.164 like 1234. + +Only used when UnansweredTargetType is SingleTarget. + +```yaml +Type: System.String +Parameter Sets: (Unanswered) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnansweredTargetType + +The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. + +SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's +delegates. Group is used when forwarding the unanswered call to the specified user's call group. + +```yaml +Type: System.String +Parameter Sets: (Unanswered) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PowerShell module 4.0.0 or later. + +The specified user need to have the Microsoft Phone System license assigned. + +When forwarding to MyDelegates, the specified user needs to have one or more delegates defined that are allowed to receive calls. When forwarding to Group, the +specified user needs to have one or more members of the user's call group. + +The cmdlet is validating the different settings and is always writing all the parameters in a settings group. You might see validation errors from the cmdlet due to +this behavior. As an example, if you have ForwardingTargetType set to Group and you want to remove all members of the call group, you will get a validation error. + +You can specify a SIP URI without 'sip:' on input, but the output from Get-CsUserCallingSettings will show the full SIP URI. + +You are not able to configure delegates via this cmdlet. Please use New-CsUserCallingDelegate, Set-CsUserCallingDelegate cmdlets and Remove-CsUserCallingDelegate. + +## RELATED LINKS +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) + +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) + +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) + +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md b/teams/teams-ps/MicrosoftTeams/Set-CsVideoInteropServiceProvider.md similarity index 99% rename from teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md rename to teams/teams-ps/MicrosoftTeams/Set-CsVideoInteropServiceProvider.md index 87c3b8383b..3794f78731 100644 --- a/teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/MicrosoftTeams/Set-CsVideoInteropServiceProvider.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/set-csvideointeropserviceprovider applicable: Microsoft Teams -Module Name: MicrosoftTeams -title: Set-CsVideoInteropServiceProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/set-csvideointeropserviceprovider +schema: 2.0.0 +title: Set-CsVideoInteropServiceProvider --- # Set-CsVideoInteropServiceProvider diff --git a/teams/teams-ps/teams/Set-Team.md b/teams/teams-ps/MicrosoftTeams/Set-Team.md similarity index 99% rename from teams/teams-ps/teams/Set-Team.md rename to teams/teams-ps/MicrosoftTeams/Set-Team.md index ec7260f07c..ab3dd009ec 100644 --- a/teams/teams-ps/teams/Set-Team.md +++ b/teams/teams-ps/MicrosoftTeams/Set-Team.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/set-team -title: Set-Team schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Set-Team --- # Set-Team @@ -40,27 +40,26 @@ Set-Team -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -DisplayName "Updated Tea ## PARAMETERS -### -GroupId -GroupId of the team +### -AllowAddRemoveApps +Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Team display name. -Team Name Characters Limit - 256. +### -AllowChannelMentions +Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -71,13 +70,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Team description. -Team Description Characters Limit - 1024. +### -AllowCreatePrivateChannels +Determines whether private channel creation is allowed for the team. ```yaml -Type: String -Parameter Sets: (All) +Type: Boolean +Parameter Sets: CreateTeam Aliases: Required: False @@ -87,13 +85,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MailNickName -The MailNickName parameter specifies the alias for the associated Office 365 Group. -This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. -The value of the MailNickName parameter has to be unique across your tenant. +### -AllowCreateUpdateChannels +Setting that determines whether or not members (and not just owners) are allowed to create channels. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -104,11 +100,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Classification -This parameter is reserved for internal Microsoft use. +### -AllowCreateUpdateRemoveConnectors +Setting that determines whether or not members (and not only owners) can manage connectors in the team. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -119,12 +115,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Visibility -Team visibility. -Valid values are "Private" and "Public" +### -AllowCreateUpdateRemoveTabs +Setting that determines whether or not members (and not only owners) can manage tabs in channels. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -135,8 +130,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAddRemoveApps -Boolean value that determines whether or not members (not only owners) are allowed to add apps to the team. +### -AllowCustomMemes +Setting that determines whether or not members can use the custom memes functionality in teams. ```yaml Type: Boolean @@ -150,8 +145,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowChannelMentions -Boolean value that determines whether or not channels in the team can be @ mentioned so that all users who follow the channel are notified. +### -AllowDeleteChannels +Setting that determines whether or not members (and not only owners) can delete channels in the team. ```yaml Type: Boolean @@ -165,8 +160,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreateUpdateChannels -Setting that determines whether or not members (and not just owners) are allowed to create channels. +### -AllowGiphy +Setting that determines whether or not giphy can be used in the team. ```yaml Type: Boolean @@ -180,8 +175,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreateUpdateRemoveConnectors -Setting that determines whether or not members (and not only owners) can manage connectors in the team. +### -AllowGuestCreateUpdateChannels +Setting that determines whether or not guests can create channels in the team. ```yaml Type: Boolean @@ -195,8 +190,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreateUpdateRemoveTabs -Setting that determines whether or not members (and not only owners) can manage tabs in channels. +### -AllowGuestDeleteChannels +Setting that determines whether or not guests can delete in the team. ```yaml Type: Boolean @@ -210,8 +205,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCustomMemes -Setting that determines whether or not members can use the custom memes functionality in teams. +### -AllowOwnerDeleteMessages +Setting that determines whether or not owners can delete messages that they or other members of the team have posted. ```yaml Type: Boolean @@ -225,8 +220,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDeleteChannels -Setting that determines whether or not members (and not only owners) can delete channels in the team. +### -AllowStickersAndMemes +Setting that determines whether stickers and memes usage is allowed in the team. ```yaml Type: Boolean @@ -240,8 +235,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowGiphy -Setting that determines whether or not giphy can be used in the team. +### -AllowTeamMentions +Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) ```yaml Type: Boolean @@ -255,8 +250,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowGuestCreateUpdateChannels -Setting that determines whether or not guests can create channels in the team. +### -AllowUserDeleteMessages +Setting that determines whether or not members can delete messages that they have posted. ```yaml Type: Boolean @@ -270,8 +265,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowGuestDeleteChannels -Setting that determines whether or not guests can delete in the team. +### -AllowUserEditMessages +Setting that determines whether or not users can edit messages that they have posted. ```yaml Type: Boolean @@ -285,11 +280,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOwnerDeleteMessages -Setting that determines whether or not owners can delete messages that they or other members of the team have posted. +### -Classification +This parameter is reserved for internal Microsoft use. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -300,11 +295,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowStickersAndMemes -Setting that determines whether stickers and memes usage is allowed in the team. +### -Description +Team description. +Team Description Characters Limit - 1024. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -315,11 +311,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTeamMentions -Setting that determines whether the entire team can be @ mentioned (which means that all users will be notified) +### -DisplayName +Team display name. +Team Name Characters Limit - 256. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -330,11 +327,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserDeleteMessages -Setting that determines whether or not members can delete messages that they have posted. +### -GiphyContentRating +Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -345,23 +342,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserEditMessages -Setting that determines whether or not users can edit messages that they have posted. +### -GroupId +GroupId of the team ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -GiphyContentRating -Setting that determines the level of sensitivity of giphy usage that is allowed in the team. Accepted values are "Strict" or "Moderate" +### -MailNickName +The MailNickName parameter specifies the alias for the associated Office 365 Group. +This value will be used for the mail enabled object and will be used as PrimarySmtpAddress for this Office 365 Group. +The value of the MailNickName parameter has to be unique across your tenant. ```yaml Type: String @@ -389,12 +388,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCreatePrivateChannels -Determines whether private channel creation is allowed for the team. +### -Visibility +Team visibility. +Valid values are "Private" and "Public" ```yaml -Type: Boolean -Parameter Sets: CreateTeam +Type: String +Parameter Sets: (All) Aliases: Required: False diff --git a/teams/teams-ps/teams/Set-TeamArchivedState.md b/teams/teams-ps/MicrosoftTeams/Set-TeamArchivedState.md similarity index 99% rename from teams/teams-ps/teams/Set-TeamArchivedState.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamArchivedState.md index 5b3b53ee89..9112e4cf83 100644 --- a/teams/teams-ps/teams/Set-TeamArchivedState.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamArchivedState.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/set-teamarchivedstate -title: Set-TeamArchivedState schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Set-TeamArchivedState --- # Set-TeamArchivedState diff --git a/teams/teams-ps/teams/Set-TeamChannel.md b/teams/teams-ps/MicrosoftTeams/Set-TeamChannel.md similarity index 99% rename from teams/teams-ps/teams/Set-TeamChannel.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamChannel.md index 14b6fa83e6..8eefd0d4b6 100644 --- a/teams/teams-ps/teams/Set-TeamChannel.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamChannel.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/set-teamchannel -title: Set-TeamChannel schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Set-TeamChannel --- # Set-TeamChannel @@ -36,8 +36,8 @@ Set-TeamChannel -GroupId c58566a6-4bb4-4221-98d4-47677dbdbef6 -CurrentDisplayNam ## PARAMETERS -### -GroupId -GroupId of the team +### -CurrentDisplayName +Current channel name ```yaml Type: String @@ -51,41 +51,41 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -CurrentDisplayName -Current channel name +### -Description +Updated Channel description. +Channel Description Characters Limit - 1024. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -NewDisplayName -New Channel display name. -Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : \< \> ? -+ | ' " +### -GroupId +GroupId of the team ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Description -Updated Channel description. -Channel Description Characters Limit - 1024. +### -NewDisplayName +New Channel display name. +Names must be 50 characters or less, and can't contain the characters # % & * { } / \ : \< \> ? ++ | ' " ```yaml Type: String diff --git a/teams/teams-ps/teams/Set-TeamPicture.md b/teams/teams-ps/MicrosoftTeams/Set-TeamPicture.md similarity index 99% rename from teams/teams-ps/teams/Set-TeamPicture.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamPicture.md index eeb537153b..bae15e0825 100644 --- a/teams/teams-ps/teams/Set-TeamPicture.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamPicture.md @@ -1,25 +1,19 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/set-teampicture -title: Set-TeamPicture schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Set-TeamPicture --- # Set-TeamPicture ## SYNOPSIS - Update the team picture. -Note: the command will return immediately, but the Teams application will not reflect the update immediately. -The Teams application may need to be open for up to an hour before changes are reflected. - -Note: this cmdlet is not support in special government environments (TeamsGCCH and TeamsDoD) and is currently only supported in our beta release. - ## SYNTAX ``` @@ -27,6 +21,10 @@ Set-TeamPicture -GroupId -ImagePath [] ``` ## DESCRIPTION +Note: the command will return immediately, but the Teams application will not reflect the update immediately. +The Teams application may need to be open for up to an hour before changes are reflected. + +Note: this cmdlet is not support in special government environments (TeamsGCCH and TeamsDoD) and is currently only supported in our beta release. ## EXAMPLES diff --git a/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md b/teams/teams-ps/MicrosoftTeams/Set-TeamTargetingHierarchy.md similarity index 99% rename from teams/teams-ps/teams/Set-TeamTargetingHierarchy.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamTargetingHierarchy.md index 4f8a952534..28e16751a4 100644 --- a/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamTargetingHierarchy.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams +ms.author: serdars online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams -title: Set-TeamTargetingHierarchy schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: +title: Set-TeamTargetingHierarchy --- # Set-TeamTargetingHierarchy @@ -47,35 +47,35 @@ requestId c67e86109d88479e9708c3b7e8ff7217 ## PARAMETERS -### -FilePath -Specifies the path to a CSV file that defines the hierarchy. +### -ApiVersion +The version of the Hierarchy APIs to use. Valid values are: 1 or 2. + +Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named -Default value: None -Accept pipeline input: False +Default value: 1 +Accept pipeline input: false Accept wildcard characters: False ``` -### -ApiVersion -The version of the Hierarchy APIs to use. Valid values are: 1 or 2. - -Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. +### -FilePath +Specifies the path to a CSV file that defines the hierarchy. ```yaml Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named -Default value: 1 -Accept pipeline input: false +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/teams/teams-ps/teams/Set-TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Set-TeamsApp.md similarity index 99% rename from teams/teams-ps/teams/Set-TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamsApp.md index 3f493249cb..e58743b94a 100644 --- a/teams/teams-ps/teams/Set-TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamsApp.md @@ -1,9 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-teamsapp -title: Set-TeamsApp schema: 2.0.0 +title: Set-TeamsApp --- # Set-TeamsApp diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/MicrosoftTeams/Set-TeamsEnvironmentConfig.md similarity index 99% rename from teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md rename to teams/teams-ps/MicrosoftTeams/Set-TeamsEnvironmentConfig.md index 81c1a3382e..5f41df75af 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/MicrosoftTeams/Set-TeamsEnvironmentConfig.md @@ -1,13 +1,14 @@ --- +author: VikneshMSFT external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Locale: en-US +manager: vinelap Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-teamsenvironmentconfig -title: Set-TeamsEnvironmentConfig -schema: 2.0.0 -author: VikneshMSFT ms.author: vimohan ms.reviewer: pbafna -manager: vinelap +online version: https://learn.microsoft.com/powershell/module/teams/set-teamsenvironmentconfig +schema: 2.0.0 +title: Set-TeamsEnvironmentConfig --- # Set-TeamsEnvironmentConfig diff --git a/teams/teams-ps/teams/Start-CsExMeetingMigration.md b/teams/teams-ps/MicrosoftTeams/Start-CsExMeetingMigration.md similarity index 98% rename from teams/teams-ps/teams/Start-CsExMeetingMigration.md rename to teams/teams-ps/MicrosoftTeams/Start-CsExMeetingMigration.md index 411d082929..42b0bc2f36 100644 --- a/teams/teams-ps/teams/Start-CsExMeetingMigration.md +++ b/teams/teams-ps/MicrosoftTeams/Start-CsExMeetingMigration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/start-csexmeetingmigration applicable: Microsoft Teams -title: Start-CsExMeetingMigration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/start-csexmeetingmigration +schema: 2.0.0 +title: Start-CsExMeetingMigration --- # Start-CsExMeetingMigration @@ -29,7 +31,7 @@ Also, with `Start-CsExMeetingMigration` cmdlet, you can start a meeting migratio ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Start-CsExMeetingMigration -Identity ashaw@contoso.com -TargetMeetingType Teams ``` diff --git a/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md b/teams/teams-ps/MicrosoftTeams/Sync-CsOnlineApplicationInstance.md similarity index 94% rename from teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md rename to teams/teams-ps/MicrosoftTeams/Sync-CsOnlineApplicationInstance.md index 8076e411c3..8ae8e21896 100644 --- a/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Sync-CsOnlineApplicationInstance.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance applicable: Microsoft Teams -title: Sync-CsOnlineApplicationInstance -schema: 2.0.0 author: serdarsoysal -ms.author: serdars +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US manager: naveenv -ms.reviewer: +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance +schema: 2.0.0 +title: Sync-CsOnlineApplicationInstance --- # Sync-CsOnlineApplicationInstance ## SYNOPSIS -Use the Sync-CsOnlineApplicationInstance cmdlet to sync the application instance from Microsoft Entra ID into Agent Provisioning Service. This is needed because the mapping between application instance and application needs to be stored in Agent Provisioning Service. If an application ID was provided at the creation of the application instance, you need not run this cmdlet. +Sync the application instance from Microsoft Entra ID into Agent Provisioning Service. ## SYNTAX @@ -22,18 +23,18 @@ Sync-CsOnlineApplicationInstance -ObjectId [-CallbackUri ] [-Forc ``` ## DESCRIPTION -Use the Sync-CsOnlineApplicationInstance cmdlet to sync application instances from Microsoft Entra ID into Agent Provisioning Service. +Use the Sync-CsOnlineApplicationInstance cmdlet to sync the application instance from Microsoft Entra ID into Agent Provisioning Service. This is needed because the mapping between application instance and application needs to be stored in Agent Provisioning Service. If an application ID was provided at the creation of the application instance, you need not run this cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Sync-CsOnlineApplicationInstance -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationId yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy ``` This example sync application instance with object ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" and application ID "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy" into Agent Provisioning Service. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Sync-CsOnlineApplicationInstance -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationId 00000000-0000-0000-0000-000000000000 ``` @@ -43,11 +44,11 @@ The command removes the mapping for application instance with object ID "xxxxxxx ## PARAMETERS -### -CallbackUri -This parameter is reserved for internal Microsoft use. +### -AcsResourceId +The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: @@ -58,8 +59,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ObjectId -The application instance ID. +### -ApplicationId +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. ```yaml Type: System.Guid @@ -73,11 +74,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. +### -CallbackUri +This parameter is reserved for internal Microsoft use. ```yaml -Type: System.Guid +Type: String Parameter Sets: (All) Aliases: @@ -88,13 +89,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcsResourceId -The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -118,14 +119,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -ObjectId +The application instance ID. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -134,13 +134,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md b/teams/teams-ps/MicrosoftTeams/Test-CsEffectiveTenantDialPlan.md similarity index 97% rename from teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md rename to teams/teams-ps/MicrosoftTeams/Test-CsEffectiveTenantDialPlan.md index 1402626383..f58d2868ae 100644 --- a/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsEffectiveTenantDialPlan.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-cseffectivetenantdialplan applicable: Microsoft Teams -title: Test-CsEffectiveTenantDialPlan -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/test-cseffectivetenantdialplan +schema: 2.0.0 +title: Test-CsEffectiveTenantDialPlan --- # Test-CsEffectiveTenantDialPlan @@ -34,14 +36,14 @@ The `Test-CsEffectiveTenantDialPlan` cmdlet normalizes the dialed number by appl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsEffectiveTenantDialPlan -Identity adelev | Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 ``` This example gets the Identity of a dial plan that is associated with the identity of a user, and applies the retrieved tenant dial plan to normalize the dialed number. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 -Identity adelev@contoso.onmicrosoft.com ``` @@ -50,13 +52,13 @@ This example tests the given dialed number against a specific identity. ## PARAMETERS -### -DialedNumber -The DialedNumber parameter is the phone number to be normalized with the effective tenant dial plan. +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: PhoneNumber +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False @@ -66,11 +68,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Indicates the identity of the user account to be tested against. The user's SIP address, the user's user principal name (UPN) or the user's display name can be specified. +### -DialedNumber +The DialedNumber parameter is the phone number to be normalized with the effective tenant dial plan. ```yaml -Type: UserIdParameter +Type: PhoneNumber Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -82,13 +84,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -EffectiveTenantDialPlanName +The EffectiveTenantDialPlanName parameter is the effective tenant dial plan name in the form of TenantId_TenantDialPlan_GlobalVoiceDialPlan. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams Required: False @@ -116,14 +118,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. +### -Identity +Indicates the identity of the user account to be tested against. The user's SIP address, the user's user principal name (UPN) or the user's display name can be specified. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: wi +Aliases: applicable: Microsoft Teams Required: False @@ -133,11 +134,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EffectiveTenantDialPlanName -The EffectiveTenantDialPlanName parameter is the effective tenant dial plan name in the form of TenantId_TenantDialPlan_GlobalVoiceDialPlan. +### -TenantScopeOnly +Runs the test only against Tenant-level dial plans (does not take into account Service Level Dial Plans). ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -149,13 +150,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantScopeOnly -Runs the test only against Tenant-level dial plans (does not take into account Service Level Dial Plans). +### -WhatIf +The WhatIf switch causes the command to simulate its results. +By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi applicable: Microsoft Teams Required: False diff --git a/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md b/teams/teams-ps/MicrosoftTeams/Test-CsInboundBlockedNumberPattern.md similarity index 98% rename from teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/MicrosoftTeams/Test-CsInboundBlockedNumberPattern.md index 56da11fbfd..9c0315f33b 100644 --- a/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsInboundBlockedNumberPattern.md @@ -1,11 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern applicable: Microsoft Teams -title: Test-CsInboundBlockedNumberPattern author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern +title: Test-CsInboundBlockedNumberPattern --- # Test-CsInboundBlockedNumberPattern diff --git a/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsShiftsConnectionValidate.md similarity index 98% rename from teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md rename to teams/teams-ps/MicrosoftTeams/Test-CsTeamsShiftsConnectionValidate.md index 7d7fd3966d..6dd836bc77 100644 --- a/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsShiftsConnectionValidate.md @@ -1,12 +1,13 @@ --- +author: gucsun external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: navinth Module Name: MicrosoftTeams -title: Test-CsTeamsShiftsConnectionValidate -author: gucsun ms.author: gucsun -manager: navinth online version: https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate schema: 2.0.0 +title: Test-CsTeamsShiftsConnectionValidate --- # Test-CsTeamsShiftsConnectionValidate @@ -51,13 +52,14 @@ Returns the list of conflicts if there are any. Empty result means there's no co ### -ConnectorId +> Applicable: Microsoft Teams + The ID of the shifts connector. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -65,15 +67,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name - -The connector's instance name. +### -ConnectorSpecificSettings +The connector specific settings. ```yaml -Type: String -Parameter Sets: (All) +Type: IConnectorInstanceRequestConnectorSpecificSettings +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None @@ -81,14 +82,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector specific settings. +### -Name + +> Applicable: Microsoft Teams + +The connector's instance name. ```yaml -Type: IConnectorInstanceRequestConnectorSpecificSettings -Parameter Sets: NewExpanded +Type: String +Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsTranslationRule.md similarity index 98% rename from teams/teams-ps/teams/Test-CsTeamsTranslationRule.md rename to teams/teams-ps/MicrosoftTeams/Test-CsTeamsTranslationRule.md index 42891b66a8..15bdaa357a 100644 --- a/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsTranslationRule.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule applicable: Microsoft Teams -title: Test-CsTeamsTranslationRule -schema: 2.0.0 author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: -manager: +online version: https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule +schema: 2.0.0 +title: Test-CsTeamsTranslationRule --- # Test-CsTeamsTranslationRule diff --git a/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsUnassignedNumberTreatment.md similarity index 98% rename from teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md rename to teams/teams-ps/MicrosoftTeams/Test-CsTeamsUnassignedNumberTreatment.md index 1682ef0ba6..3daa942784 100644 --- a/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsTeamsUnassignedNumberTreatment.md @@ -1,11 +1,12 @@ --- -external help file: Microsoft.TeamsCmdlets.Powershell.Custom.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment -Module Name: Microsoft Teams -title: Test-CsTeamsUnassignedNumberTreatment author: firatakandere +external help file: Microsoft.TeamsCmdlets.Powershell.Custom.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams ms.author: osakande +online version: https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment schema: 2.0.0 +title: Test-CsTeamsUnassignedNumberTreatment --- # Test-CsTeamsUnassignedNumberTreatment diff --git a/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md b/teams/teams-ps/MicrosoftTeams/Test-CsVoiceNormalizationRule.md similarity index 83% rename from teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md rename to teams/teams-ps/MicrosoftTeams/Test-CsVoiceNormalizationRule.md index 43647176a6..44ad3560a1 100644 --- a/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md +++ b/teams/teams-ps/MicrosoftTeams/Test-CsVoiceNormalizationRule.md @@ -1,21 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/test-csvoicenormalizationrule applicable: Microsoft Teams -title: Test-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/test-csvoicenormalizationrule +schema: 2.0.0 +title: Test-CsVoiceNormalizationRule --- # Test-CsVoiceNormalizationRule ## SYNOPSIS Tests a telephone number against a voice normalization rule and returns the number after the normalization rule has been applied. -Voice normalization rules are typically used to convert a telephone dialing requirement (for example, you must dial 9 to access an outside line) to the E.164 phone -number format. -This cmdlet was introduced in Lync Server 2010. ## SYNTAX @@ -25,14 +24,17 @@ Test-CsVoiceNormalizationRule -DialedNumber -NormalizationRule Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + The phone number against which you want to test the normalization rule specified in the NormalizationRule parameter. Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber @@ -100,7 +105,6 @@ Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber Type: PhoneNumber Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: True Position: Named @@ -110,6 +114,9 @@ Accept wildcard characters: False ``` ### -NormalizationRule + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + An object containing a reference to the normalization rule against which you want to test the number specified in the DialedNumber parameter. For Lync and Skype for Business Server, you can retrieve voice normalization rules by calling the `Get-CsVoiceNormalizationRule` cmdlet. @@ -119,7 +126,6 @@ For Microsoft Teams, you can retrieve voice normalization rules by calling the ` Type: NormalizationRule Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: True Position: Named diff --git a/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber.md similarity index 98% rename from teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber.md index a2f7712c39..49902dcbcc 100644 --- a/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/MicrosoftTeams/Unregister-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/unregister-csonlinedialinconferencingservicenumber applicable: Microsoft Teams -title: Unregister-CsOnlineDialInConferencingServiceNumber -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/unregister-csonlinedialinconferencingservicenumber +schema: 2.0.0 +title: Unregister-CsOnlineDialInConferencingServiceNumber --- # Unregister-CsOnlineDialInConferencingServiceNumber @@ -28,7 +30,7 @@ Unassigns the previously assigned service number as default Conference Bridge nu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Unregister-CsOnlineDialInConferencingServiceNumber -BridgeName "Conference Bridge" -RemoveDefaultServiceNumber 1234 ``` @@ -37,45 +39,45 @@ Unassigns the 1234 Service Number to the given Conference Bridge. ## PARAMETERS -### -Identity -PARAMVALUE: String +### -BridgeId +PARAMVALUE: Guid ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: ConferencingServiceNumber +### -BridgeName +PARAMVALUE: String ```yaml -Type: ConferencingServiceNumber +Type: String Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeId -PARAMVALUE: Guid +### -DomainController +PARAMVALUE: Fqdn ```yaml -Type: Guid +Type: Fqdn Parameter Sets: (All) -Aliases: +Aliases: DC applicable: Microsoft Teams Required: False @@ -85,11 +87,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BridgeName -PARAMVALUE: String +### -Force +PARAMVALUE: SwitchParameter ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: applicable: Microsoft Teams @@ -101,33 +103,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -PARAMVALUE: Fqdn +### -Identity +PARAMVALUE: String ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: DC +Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Instance +PARAMVALUE: ConferencingServiceNumber ```yaml -Type: SwitchParameter +Type: ConferencingServiceNumber Parameter Sets: (All) Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Update-CsAutoAttendant.md b/teams/teams-ps/MicrosoftTeams/Update-CsAutoAttendant.md similarity index 97% rename from teams/teams-ps/teams/Update-CsAutoAttendant.md rename to teams/teams-ps/MicrosoftTeams/Update-CsAutoAttendant.md index e904781ef4..975cdb45cc 100644 --- a/teams/teams-ps/teams/Update-CsAutoAttendant.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsAutoAttendant.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/update-csautoattendant applicable: Microsoft Teams -title: Update-CsAutoAttendant -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/teams/update-csautoattendant +schema: 2.0.0 +title: Update-CsAutoAttendant --- # Update-CsAutoAttendant @@ -28,7 +30,7 @@ Note: This cmdlet only triggers the refresh of auto attendant resources. It does ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Update-CsAutoAttendant -Identity "6abea1cd-904b-520b-be96-1092cc096432" ``` diff --git a/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md b/teams/teams-ps/MicrosoftTeams/Update-CsCustomPolicyPackage.md similarity index 97% rename from teams/teams-ps/teams/Update-CsCustomPolicyPackage.md rename to teams/teams-ps/MicrosoftTeams/Update-CsCustomPolicyPackage.md index b993377f9a..fe317ecd49 100644 --- a/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsCustomPolicyPackage.md @@ -1,12 +1,13 @@ --- +author: sunguchuan external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Locale: en-US +manager: dasosby Module Name: MicrosoftTeams -title: Update-CsCustomPolicyPackage -author: sunguchuan ms.author: gucsun -manager: dasosby online version: https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage schema: 2.0.0 +title: Update-CsCustomPolicyPackage --- # Update-CsCustomPolicyPackage @@ -44,49 +45,52 @@ Updates the custom package named "MyPackage" to have a description of "My packag ## PARAMETERS -### -Identity +### -Description -The name of the custom package. +> Applicable: Microsoft Teams + +The description of the custom package. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True -Position: 0 +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyList +### -Identity -A list of one or more policies to be included in the updated package. To specify the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy). +> Applicable: Microsoft Teams + +The name of the custom package. ```yaml -Type: String[] +Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -PolicyList -The description of the custom package. +> Applicable: Microsoft Teams + +A list of one or more policies to be included in the updated package. To specify the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy). ```yaml -Type: String +Type: String[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/teams/teams-ps/teams/Update-CsPhoneNumberTag.md b/teams/teams-ps/MicrosoftTeams/Update-CsPhoneNumberTag.md similarity index 97% rename from teams/teams-ps/teams/Update-CsPhoneNumberTag.md rename to teams/teams-ps/MicrosoftTeams/Update-CsPhoneNumberTag.md index 31d633d8dd..f932d4a5e7 100644 --- a/teams/teams-ps/teams/Update-CsPhoneNumberTag.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsPhoneNumberTag.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/update-csphonenumbertag applicable: Microsoft Teams -title: Update-CsPhoneNumberTag author: pavellatif +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +manager: roykuntz +Module Name: MicrosoftTeams ms.author: pavellatif ms.reviewer: pavellatif -manager: roykuntz +online version: https://learn.microsoft.com/powershell/module/teams/update-csphonenumbertag schema: 2.0.0 +title: Update-CsPhoneNumberTag --- # Update-CsPhoneNumberTag diff --git a/teams/teams-ps/teams/Update-CsTeamTemplate.md b/teams/teams-ps/MicrosoftTeams/Update-CsTeamTemplate.md similarity index 97% rename from teams/teams-ps/teams/Update-CsTeamTemplate.md rename to teams/teams-ps/MicrosoftTeams/Update-CsTeamTemplate.md index 67710e31ba..b61751d7b3 100644 --- a/teams/teams-ps/teams/Update-CsTeamTemplate.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsTeamTemplate.md @@ -1,809 +1,809 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate -title: Update-CsTeamTemplate -author: serdarsoysal -ms.author: serdars -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# Update-CsTeamTemplate - -## SYNOPSIS - -This cmdlet submits an operation that updates a custom team template with new team template settings. - -NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. - -## SYNTAX - -### UpdateExpanded (Default) - -```powershell -Update-CsTeamTemplate -OdataId -DisplayName -ShortDescription - [-App ] [-Category ] [-Channel ] - [-Classification ] [-Description ] [-DiscoverySetting ] - [-FunSetting ] [-GuestSetting ] [-Icon ] - [-IsMembershipLimitedToOwner] [-MemberSetting ] - [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] - [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-Confirm] [-WhatIf] - [] -``` - -### Update - -```powershell -Update-CsTeamTemplate -OdataId -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### UpdateViaIdentity - -```powershell -Update-CsTeamTemplate -InputObject -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### UpdateViaIdentityExpanded - -```powershell -Update-CsTeamTemplate -InputObject -DisplayName - -ShortDescription [-App ] [-Category ] - [-Channel ] [-Classification ] [-Description ] - [-DiscoverySetting ] [-FunSetting ] - [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] - [-MemberSetting ] [-MessagingSetting ] - [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] - [-Uri ] [-Visibility ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS C:\> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR') > input.json -# open json in your favorite editor, make changes - -Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body (Get-Content '.\input.json' | Out-String) -``` - -Step 1: Creates a JSON file of the template you have specified. -Step 2: Updates the template with JSON file you have edited. - -### EXAMPLE 2 - -```powershell -PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` -DisplayName='New Template';` -ShortDescription='Short Definition';` -Description='New Description';` -App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` -Channel=@{` - displayName = "General";` - id= "General";` - isFavoriteByDefault= $true` - },` - @{` - displayName= "test";` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` - isFavoriteByDefault= $false` - }` -} - -PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body $template -``` - -Update to a new object - -### EXAMPLE 3 - -```powershell -PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' ` --Locale en-US -DisplayName 'New Template' ` --ShortDescription 'New Description' ` --App @{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'} ` --Channel @{ ` -displayName = "General"; ` -id= "General"; ` -isFavoriteByDefault= $true ` -}, ` -@{ ` - displayName= "test"; ` - id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` - isFavoriteByDefault= $false ` -} -``` -> [!Note] -> It can take up to 24 hours for Teams users to see a custom template change in the gallery. - -## PARAMETERS - -### -App - -Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. -To construct, see NOTES section for APP properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body - -The client input for a request to create a template. -Only admins from Config Api can perform this request. -To construct, see NOTES section for BODY properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate -Parameter Sets: Update, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Category - -Gets or sets list of categories. - -```yaml -Type: System.String[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Channel - -Gets or sets the set of channel templates included in the team template. -To construct, see NOTES section for CHANNEL properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Classification - -Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Gets or sets the team's Description. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoverySetting - -Governs discoverability of a team. -To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName - -Gets or sets the team's DisplayName. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunSetting - -Governs use of fun media like giphy and stickers in the team. -To construct, see NOTES section for FUNSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GuestSetting - -Guest role settings for the team. -To construct, see NOTES section for GUESTSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Icon - -Gets or sets template icon. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsMembershipLimitedToOwner - -Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberSetting - -Member role settings for the team. -To construct, see NOTES section for MEMBERSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessagingSetting - -Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. -To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. - -```yaml -Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OdataId - -A composite URI of a template. - -```yaml -Type: System.String -Parameter Sets: Update, UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerUserObjectId - -Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishedBy - -Gets or sets published name. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShortDescription - -Gets or sets template short description. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Specialization - -The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateId - -Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri - -Gets or sets uri to be used for GetTemplate api call. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Visibility - -Used to control the scope of users who can view a group/team and its members, and ability to join. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break - -Wait for .NET debugger to attach - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend - -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend - -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy - -The URI for the proxy server to use - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential - -Credentials for a proxy server to use for the remote call - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials - -Use the default credentials for the proxy - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate - -## OUTPUTS - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse - -### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - -APP \: Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. - -- `[Id ]`: Gets or sets the app's ID in the global apps catalog. - -BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. - -- `DisplayName `: Gets or sets the team's DisplayName. -- `ShortDescription `: Gets or sets template short description. -- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. - - `[Id ]`: Gets or sets the app's ID in the global apps catalog. -- `[Category ]`: Gets or sets list of categories. -- `[Channel ]`: Gets or sets the set of channel templates included in the team template. - - `[Description ]`: Gets or sets channel description as displayed to users. - - `[DisplayName ]`: Gets or sets channel name as displayed to users. - - `[Id ]`: Gets or sets identifier for the channel template. - - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - - `[Configuration ]`: Represents the configuration of a tab. - - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. -- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. -- `[Description ]`: Gets or sets the team's Description. -- `[DiscoverySetting ]`: Governs discoverability of a team. - - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. -- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. - - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. - - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. - - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. - - `GiphyContentRating `: Gets or sets the rating filter on giphy content. -- `[GuestSetting ]`: Guest role settings for the team. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. -- `[Icon ]`: Gets or sets template icon. -- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. -- `[MemberSetting ]`: Member role settings for the team. - - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. - - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. - - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. - - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. - - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. - - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. - - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. -- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. - - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. - - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. - - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. -- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. -- `[PublishedBy ]`: Gets or sets published name. -- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. -- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. -- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. -- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. - -CHANNEL : Gets or sets the set of channel templates included in the team template. - -- `[Description ]`: Gets or sets channel description as displayed to users. -- `[DisplayName ]`: Gets or sets channel name as displayed to users. -- `[Id ]`: Gets or sets identifier for the channel template. -- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. -- `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - - `[Configuration ]`: Represents the configuration of a tab. - - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. - - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. - - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. - - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. - - `[Id ]`: Gets or sets identifier for the channel tab template. - - `[Key ]`: Gets a unique identifier. - - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. - - `[Name ]`: Gets or sets the tab name displayed to users. - - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. - -DISCOVERYSETTING \: Governs discoverability of a team. - -- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. - -FUNSETTING \: Governs use of fun media like giphy and stickers in the team. - -- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. -- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. -- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. -- `GiphyContentRating `: Gets or sets the rating filter on giphy content. - -GUESTSETTING \: Guest role settings for the team. - -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. - -INPUTOBJECT \: Identity Parameter - -- `[Bssid ]`: -- `[ChassisId ]`: -- `[CivicAddressId ]`: Civic address id. -- `[Country ]`: -- `[GroupId ]`: The ID of a group whose policy assignments will be returned. -- `[Id ]`: -- `[Identity ]`: -- `[Locale ]`: -- `[LocationId ]`: Location id. -- `[OdataId ]`: A composite URI of a template. -- `[OperationId ]`: The ID of a batch policy assignment operation. -- `[OrderId ]`: -- `[PackageName ]`: The name of a specific policy package -- `[PolicyType ]`: The policy type for which group policy assignments will be returned. -- `[Port ]`: -- `[PortInOrderId ]`: -- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. -- `[SubnetId ]`: -- `[TenantId ]`: -- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. - -MEMBERSETTING \: Member role settings for the team. - -- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. -- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. -- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. -- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. -- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. -- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. -- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. - -MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. - -- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. -- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. -- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. -- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. -- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. - -## RELATED LINKS - -- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +--- +author: serdarsoysal +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US +Module Name: MicrosoftTeams +ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate +schema: 2.0.0 +title: Update-CsTeamTemplate +--- + +# Update-CsTeamTemplate + +## SYNOPSIS + +This cmdlet submits an operation that updates a custom team template with new team template settings. + +## SYNTAX + +### UpdateExpanded (Default) + +```powershell +Update-CsTeamTemplate -OdataId -DisplayName -ShortDescription + [-App ] [-Category ] [-Channel ] + [-Classification ] [-Description ] [-DiscoverySetting ] + [-FunSetting ] [-GuestSetting ] [-Icon ] + [-IsMembershipLimitedToOwner] [-MemberSetting ] + [-MessagingSetting ] [-OwnerUserObjectId ] [-PublishedBy ] + [-Specialization ] [-TemplateId ] [-Uri ] [-Visibility ] [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-Confirm] [-WhatIf] + [] +``` + +### Update + +```powershell +Update-CsTeamTemplate -OdataId -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentity + +``` +Update-CsTeamTemplate -InputObject -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded + +``` +Update-CsTeamTemplate -InputObject -DisplayName + -ShortDescription [-App ] [-Category ] + [-Channel ] [-Classification ] [-Description ] + [-DiscoverySetting ] [-FunSetting ] + [-GuestSetting ] [-Icon ] [-IsMembershipLimitedToOwner] + [-MemberSetting ] [-MessagingSetting ] + [-OwnerUserObjectId ] [-PublishedBy ] [-Specialization ] [-TemplateId ] + [-Uri ] [-Visibility ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR') > input.json +# open json in your favorite editor, make changes + +Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body (Get-Content '.\input.json' | Out-String) +``` + +Step 1: Creates a JSON file of the template you have specified. +Step 2: Updates the template with JSON file you have edited. + +### EXAMPLE 2 + +```powershell +PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` +DisplayName='New Template';` +ShortDescription='Short Definition';` +Description='New Description';` +App=@{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'};` +Channel=@{` + displayName = "General";` + id= "General";` + isFavoriteByDefault= $true` + },` + @{` + displayName= "test";` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475";` + isFavoriteByDefault= $false` + }` +} + +PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body $template +``` + +Update to a new object + +### EXAMPLE 3 + +```powershell +PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' ` +-Locale en-US -DisplayName 'New Template' ` +-ShortDescription 'New Description' ` +-App @{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'} ` +-Channel @{ ` +displayName = "General"; ` +id= "General"; ` +isFavoriteByDefault= $true ` +}, ` +@{ ` + displayName= "test"; ` + id= "b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` + isFavoriteByDefault= $false ` +} +``` +> [!Note] +> It can take up to 24 hours for Teams users to see a custom template change in the gallery. + +## PARAMETERS + +### -App + +Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. +To construct, see NOTES section for APP properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamsAppTemplate[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body + +The client input for a request to create a template. +Only admins from Config Api can perform this request. +To construct, see NOTES section for BODY properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break + +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Category + +Gets or sets list of categories. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Channel + +Gets or sets the set of channel templates included in the team template. +To construct, see NOTES section for CHANNEL properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IChannelTemplate[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Classification + +Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Gets or sets the team's Description. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoverySetting + +Governs discoverability of a team. +To construct, see NOTES section for DISCOVERYSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamDiscoverySettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName + +Gets or sets the team's DisplayName. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FunSetting + +Governs use of fun media like giphy and stickers in the team. +To construct, see NOTES section for FUNSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamFunSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GuestSetting + +Guest role settings for the team. +To construct, see NOTES section for GUESTSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamGuestSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend + +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend + +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Icon + +Gets or sets template icon. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsMembershipLimitedToOwner + +Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberSetting + +Member role settings for the team. +To construct, see NOTES section for MEMBERSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMemberSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingSetting + +Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. +To construct, see NOTES section for MESSAGINGSETTING properties and create a hash table. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamMessagingSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OdataId + +A composite URI of a template. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwnerUserObjectId + +Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy + +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential + +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials + +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishedBy + +Gets or sets published name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShortDescription + +Gets or sets template short description. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Specialization + +The specialization or use case describing the team.Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateId + +Gets or sets the id of the base template for the team.Either a Microsoft base template or a custom template. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri + +Gets or sets uri to be used for GetTemplate api call. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Visibility + +Used to control the scope of users who can view a group/team and its members, and ability to join. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ITeamTemplate + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICreateTemplateResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +APP \: Gets or sets the set of applications that should be installed in teams created based on the template.The app catalog is the main directory for information about each app; this set is intended only as a reference. + +- `[Id ]`: Gets or sets the app's ID in the global apps catalog. + +BODY \: The client input for a request to create a template. Only admins from Config Api can perform this request. + +- `DisplayName `: Gets or sets the team's DisplayName. +- `ShortDescription `: Gets or sets template short description. +- `[App ]`: Gets or sets the set of applications that should be installed in teams created based on the template. The app catalog is the main directory for information about each app; this set is intended only as a reference. + - `[Id ]`: Gets or sets the app's ID in the global apps catalog. +- `[Category ]`: Gets or sets list of categories. +- `[Channel ]`: Gets or sets the set of channel templates included in the team template. + - `[Description ]`: Gets or sets channel description as displayed to users. + - `[DisplayName ]`: Gets or sets channel name as displayed to users. + - `[Id ]`: Gets or sets identifier for the channel template. + - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. + - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration ]`: Represents the configuration of a tab. + - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. +- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. +- `[Description ]`: Gets or sets the team's Description. +- `[DiscoverySetting ]`: Governs discoverability of a team. + - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. +- `[FunSetting ]`: Governs use of fun media like giphy and stickers in the team. + - `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. + - `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. + - `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. + - `GiphyContentRating `: Gets or sets the rating filter on giphy content. +- `[GuestSetting ]`: Guest role settings for the team. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. +- `[Icon ]`: Gets or sets template icon. +- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. +- `[MemberSetting ]`: Member role settings for the team. + - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. + - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. + - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. + - `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. + - `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. + - `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. + - `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. +- `[MessagingSetting ]`: Governs use of messaging features within the team These are settings the team owner should be able to modify from UI after team creation. + - `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. + - `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. + - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. + - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. + - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. +- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. +- `[PublishedBy ]`: Gets or sets published name. +- `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. +- `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. +- `[Uri ]`: Gets or sets uri to be used for GetTemplate api call. +- `[Visibility ]`: Used to control the scope of users who can view a group/team and its members, and ability to join. + +CHANNEL : Gets or sets the set of channel templates included in the team template. + +- `[Description ]`: Gets or sets channel description as displayed to users. +- `[DisplayName ]`: Gets or sets channel name as displayed to users. +- `[Id ]`: Gets or sets identifier for the channel template. +- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. +- `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. + - `[Configuration ]`: Represents the configuration of a tab. + - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. + - `[EntityId ]`: Gets or sets the identifier for the entity hosted by the tab provider. + - `[RemoveUrl ]`: Gets or sets the Url that is invoked when the user tries to remove a tab from the FE client. + - `[WebsiteUrl ]`: Gets or sets the Url for showing tab contents outside of Teams. + - `[Id ]`: Gets or sets identifier for the channel tab template. + - `[Key ]`: Gets a unique identifier. + - `[MessageId ]`: Gets or sets id used to identify the chat message associated with the tab. + - `[Name ]`: Gets or sets the tab name displayed to users. + - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. + - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. + - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. + +DISCOVERYSETTING \: Governs discoverability of a team. + +- `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. + +FUNSETTING \: Governs use of fun media like giphy and stickers in the team. + +- `AllowCustomMeme `: Gets or sets a value indicating whether users are allowed to create and post custom meme images in team conversations. +- `AllowGiphy `: Gets or sets a value indicating whether users can post giphy content in team conversations. +- `AllowStickersAndMeme `: Gets or sets a value indicating whether users can post stickers and memes in team conversations. +- `GiphyContentRating `: Gets or sets the rating filter on giphy content. + +GUESTSETTING \: Guest role settings for the team. + +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. + +INPUTOBJECT \: Identity Parameter + +- `[Bssid ]`: +- `[ChassisId ]`: +- `[CivicAddressId ]`: Civic address id. +- `[Country ]`: +- `[GroupId ]`: The ID of a group whose policy assignments will be returned. +- `[Id ]`: +- `[Identity ]`: +- `[Locale ]`: +- `[LocationId ]`: Location id. +- `[OdataId ]`: A composite URI of a template. +- `[OperationId ]`: The ID of a batch policy assignment operation. +- `[OrderId ]`: +- `[PackageName ]`: The name of a specific policy package +- `[PolicyType ]`: The policy type for which group policy assignments will be returned. +- `[Port ]`: +- `[PortInOrderId ]`: +- `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. +- `[SubnetId ]`: +- `[TenantId ]`: +- `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. + +MEMBERSETTING \: Member role settings for the team. + +- `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. +- `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. +- `AllowCreateUpdateChannel `: Gets or sets a value indicating whether members can create or edit channels in the team. +- `AllowCreateUpdateRemoveConnector `: Gets or sets a value indicating whether members can add, edit, or remove connectors in the team. +- `AllowCreateUpdateRemoveTab `: Gets or sets a value indicating whether members can add, edit or remove pinned tabs in the team. +- `AllowDeleteChannel `: Gets or sets a value indicating whether members can delete team channels. +- `UploadCustomApp `: Gets or sets a value indicating is allowed to upload custom apps. + +MESSAGINGSETTING \: Governs use of messaging features within the teamThese are settings the team owner should be able to modify from UI after team creation. + +- `AllowChannelMention `: Gets or sets a value indicating whether team members can at-mention entire channels in team conversations. +- `AllowOwnerDeleteMessage `: Gets or sets a value indicating whether team owners can delete anyone's messages in team conversations. +- `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. +- `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. +- `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. + +## RELATED LINKS + +- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnection.md similarity index 99% rename from teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md rename to teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnection.md index 776c82c956..7cf802eb6f 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnection.md @@ -1,12 +1,12 @@ --- +author: serdarsoysal external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Update-CsTeamsShiftsConnection -author: serdarsoysal ms.author: serdars -manager: online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection schema: 2.0.0 +title: Update-CsTeamsShiftsConnection --- # Update-CsTeamsShiftsConnection @@ -133,6 +133,21 @@ Updates the connection with the specified -ConnectionId with the given settings. ## PARAMETERS +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Body The request body. @@ -178,27 +193,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -ConnectionId +The WFM connection ID for the instance. +This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, Update Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -ConnectorId +Used to specify the unique identifier of the connector being used for the connection. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -208,38 +224,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The value of the ETag field as returned by the cmdlets. +### -ConnectorSpecificSettings +Used to specify settings that are unique to the connector being used. This parameter allows administrators to configure various properties specific to the workforce management (WFM) system they are integrating with Teams Shifts. ```yaml -Type: String -Parameter Sets: (All) +Type: IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter - -```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The connector instance name. +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. ```yaml Type: String @@ -253,11 +254,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: Uri +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -268,11 +269,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: PSCredential +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: @@ -283,44 +284,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -IfMatch +The value of the ETag field as returned by the cmdlets. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. +### -InputObject +Identity Parameter ```yaml -Type: String +Type: IConfigApiBasedCmdletsIdentity Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Name +The connector instance name. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: Required: False Position: Named @@ -329,11 +329,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authorization -Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String +Type: Uri Parameter Sets: (All) Aliases: @@ -344,28 +344,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId -The WFM connection ID for the instance. -This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: UpdateExpanded, Update +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId -Used to specify the unique identifier of the connector being used for the connection. +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: Required: False @@ -375,28 +374,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -Used to specify settings that are unique to the connector being used. This parameter allows administrators to configure various properties specific to the workforce management (WFM) system they are integrating with Teams Shifts. +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. ```yaml -Type: IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Etag -Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnectionInstance.md similarity index 99% rename from teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md rename to teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnectionInstance.md index 466a0bf1c7..df977dfb01 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/MicrosoftTeams/Update-CsTeamsShiftsConnectionInstance.md @@ -1,12 +1,12 @@ --- +author: nunocorreia-ms external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Locale: en-US Module Name: MicrosoftTeams -title: Update-CsTeamsShiftsConnectionInstance -author: nunocorreia-ms ms.author: nunocorreia -manager: online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance schema: 2.0.0 +title: Update-CsTeamsShiftsConnectionInstance --- # Update-CsTeamsShiftsConnectionInstance @@ -145,6 +145,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectionId +The WFM connection ID for the instance. +This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ConnectorAdminEmail Gets or sets the list of connector admin email addresses. @@ -187,54 +203,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOfferShiftRequest -The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShift -The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioOpenShiftRequest -The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SendAsyncStep[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioShift -The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -IfMatch +The value of the ETag field as returned by the cmdlets. ```yaml Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: (All) Aliases: Required: True Position: Named @@ -243,96 +260,96 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioSwapRequest -The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -InputObject +Identity Parameter ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SyncScenarioTimeCard -The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Name +The connector instance name. ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOff -The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -Proxy +The URI for the proxy server to use. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: Uri +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioTimeOffRequest -The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: PSCredential +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncScenarioUserShiftPreference -The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline. +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline. +### -SyncFrequencyInMin +The sync frequency in minutes. ```yaml -Type: SendAsyncStep[] -Parameter Sets: (All) +Type: Int32 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False Position: Named @@ -341,12 +358,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The value of the ETag field as returned by the cmdlets. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True Position: Named @@ -355,82 +372,82 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: IConfigApiBasedCmdletsIdentity -Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The connector instance name. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Uri -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call. +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: PSCredential -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -State -The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True Position: Named @@ -439,59 +456,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin -The sync frequency in minutes. +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Int32 +Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionId -The WFM connection ID for the instance. -This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: - -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Etag -Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named Default value: None diff --git a/teams/teams-ps/teams/Update-M365TeamsApp.md b/teams/teams-ps/MicrosoftTeams/Update-M365TeamsApp.md similarity index 99% rename from teams/teams-ps/teams/Update-M365TeamsApp.md rename to teams/teams-ps/MicrosoftTeams/Update-M365TeamsApp.md index 7fccff1744..397949367c 100644 --- a/teams/teams-ps/teams/Update-M365TeamsApp.md +++ b/teams/teams-ps/MicrosoftTeams/Update-M365TeamsApp.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Update-M365TeamsApp applicable: Microsoft Teams -title: Update-M365TeamsApp author: lkueter -ms.author: sribagchi +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 04/24/2024 +online version: https://docs.microsoft.com/powershell/module/teams/Update-M365TeamsApp schema: 2.0.0 +title: Update-M365TeamsApp --- # Update-M365TeamsApp @@ -76,6 +77,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AppInstallType + +App installation type. + +```yaml +Type: String +Parameter Sets: (Everyone, UsersandGroups, Noone) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Groups List of all the groups for whom the app is enabled or disabled. @@ -108,13 +125,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsBlocked +### -InstallForGroups -The state of the app in the tenant. +List of all the groups for whom the app is installed. ```yaml -Type: Boolean -Parameter Sets: (true, false) +Type: String[] +Parameter Sets: (All) Aliases: Required: False @@ -124,9 +141,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OperationType +### -InstallForOperationType -Operation performed on the app assigment. +Operation performed on the app installation. ```yaml Type: String @@ -140,9 +157,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Users +### -InstallForUsers -List of all the users for whom the app is enabled or disabled. +List of all the users for whom the app is installed. ```yaml Type: String[] @@ -156,13 +173,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppInstallType +### -InstallVersion -App installation type. +App version to be installed. ```yaml Type: String -Parameter Sets: (Everyone, UsersandGroups, Noone) Aliases: Required: True @@ -172,41 +188,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallForOperationType +### -IsBlocked -Operation performed on the app installation. +The state of the app in the tenant. ```yaml -Type: String -Parameter Sets: (Add, Remove) +Type: Boolean +Parameter Sets: (true, false) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallForUsers +### -OperationType -List of all the users for whom the app is installed. +Operation performed on the app assigment. ```yaml -Type: String[] -Parameter Sets: (All) +Type: String +Parameter Sets: (Add, Remove) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallForGroups +### -Users -List of all the groups for whom the app is installed. +List of all the users for whom the app is enabled or disabled. ```yaml Type: String[] @@ -220,21 +236,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InstallVersion - -App version to be installed. - -```yaml -Type: String -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedCustomPendingApp.md similarity index 97% rename from teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md rename to teams/teams-ps/MicrosoftTeams/Update-M365UnifiedCustomPendingApp.md index f2292aee01..987221f9b2 100644 --- a/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md +++ b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedCustomPendingApp.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Update-M365UnifiedCustomPendingApp applicable: Microsoft Teams -title: Update-M365UnifiedCustomPendingApp author: michelle-paradis -ms.author: mparadis +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: swmerchant +Module Name: MicrosoftTeams +ms.author: mparadis ms.date: 01/20/2025 +online version: https://docs.microsoft.com/powershell/module/teams/Update-M365UnifiedCustomPendingApp schema: 2.0.0 +title: Update-M365UnifiedCustomPendingApp --- # Update-M365UnifiedCustomPendingApp @@ -19,7 +20,7 @@ This cmdlet updates the review status for a custom Microsoft Teams app that is p ## SYNTAX -```powershell +``` Update-M365UnifiedCustomPendingApp -Id -ReviewStatus ``` @@ -34,6 +35,7 @@ This cmdlet allows administrators to reject or publish custom Microsoft Teams ap ```powershell PS C:\> Update-M365UnifiedCustomPendingApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -ReviewStatus Published ``` + Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b to Published. ### Example 2 @@ -41,11 +43,12 @@ Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4 ```powershell PS C:\> Update-M365UnifiedCustomPendingApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -ReviewStatus Rejected ``` + Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b to Rejected. ## PARAMETERS -### Id +### -Id Application ID of the Teams app. @@ -61,7 +64,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### ReviewStatus +### -ReviewStatus The review status of the Teams app. @@ -90,3 +93,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object ## NOTES + +## RELATED LINKS \ No newline at end of file diff --git a/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedTenantSettings.md similarity index 99% rename from teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md rename to teams/teams-ps/MicrosoftTeams/Update-M365UnifiedTenantSettings.md index ed119948d2..0cf1644465 100644 --- a/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md +++ b/teams/teams-ps/MicrosoftTeams/Update-M365UnifiedTenantSettings.md @@ -1,14 +1,15 @@ --- -external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/Update-M365UnifiedTenantSettings applicable: Microsoft Teams -title: Update-M365UnifiedTenantSettings author: lkueter -ms.author: sribagchi +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Locale: en-US manager: rahulrgupta +Module Name: MicrosoftTeams +ms.author: sribagchi ms.date: 10/22/2024 +online version: https://docs.microsoft.com/powershell/module/teams/Update-M365UnifiedTenantSettings schema: 2.0.0 +title: Update-M365UnifiedTenantSettings --- # Update-M365UnifiedTenantSettings @@ -45,28 +46,29 @@ Updates the tenant setting for GlobalApp to None ## PARAMETERS -### -SettingName +### -Groups -Setting Name to be changed. +List of all the groups for whom the app is enabled or disabled. ```yaml -Type: String -Parameter Sets: (DefaultApp, GlobalApp, PrivateApp, EnableCopilotExtensibility) +Type: String[] +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SettingValue -Setting Value to be changed. +### -Operation + +Operation performed (whether we are adding or removing users/groups). ```yaml Type: String -Parameter Sets: (All, None, Some) +Parameter Sets: (add, remove) Aliases: Required: True @@ -76,13 +78,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Operation +### -SettingName -Operation performed (whether we are adding or removing users/groups). +Setting Name to be changed. ```yaml Type: String -Parameter Sets: (add, remove) +Parameter Sets: (DefaultApp, GlobalApp, PrivateApp, EnableCopilotExtensibility) Aliases: Required: True @@ -92,25 +94,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Users - -List of all the users for whom the app is enabled or disabled. +### -SettingValue +Setting Value to be changed. ```yaml -Type: String[] -Parameter Sets: (All) +Type: String +Parameter Sets: (All, None, Some) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Groups +### -Users -List of all the groups for whom the app is enabled or disabled. +List of all the users for whom the app is enabled or disabled. ```yaml Type: String[] diff --git a/teams/teams-ps/teams/export-csonlineaudiofile.md b/teams/teams-ps/MicrosoftTeams/export-csonlineaudiofile.md similarity index 96% rename from teams/teams-ps/teams/export-csonlineaudiofile.md rename to teams/teams-ps/MicrosoftTeams/export-csonlineaudiofile.md index f0b747b543..43bc516d15 100644 --- a/teams/teams-ps/teams/export-csonlineaudiofile.md +++ b/teams/teams-ps/MicrosoftTeams/export-csonlineaudiofile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile applicable: Microsoft Teams -title: Export-CsOnlineAudioFile -schema: 2.0.0 -manager: bulenteg author: serdarsoysal +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: MicrosoftTeams ms.author: serdars -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile +schema: 2.0.0 +title: Export-CsOnlineAudioFile --- # Export-CsOnlineAudioFile @@ -26,7 +27,7 @@ The Export-CsOnlineAudioFile cmdlet downloads an existing Auto Attendant (AA), C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell $content=Export-CsOnlineAudioFile -ApplicationId "HuntGroup" -Identity 57f800408f8848548dd1fbc18073fe46 [System.IO.File]::WriteAllBytes('C:\MyWaveFile.wav', $content) @@ -37,6 +38,9 @@ This example exports a Call Queue audio file and saves it as MyWaveFile.wav. ## PARAMETERS ### -ApplicationId + +> Applicable: Microsoft Teams + The ApplicationId parameter is the identifier for the application which will use this audio file. For example, if the audio file is used with an organizational auto attendant, then it needs to be set to "OrgAutoAttendant". If the audio file is used with a hunt group (call queue), then it needs to be set to "HuntGroup". If the audio file is used with Microsoft Teams, then it needs to be set to "TenantGlobal" Supported values: @@ -49,7 +53,6 @@ Supported values: Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named diff --git a/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md b/teams/teams-ps/MicrosoftTeams/get-csteamsmessagingconfiguration.md similarity index 96% rename from teams/teams-ps/teams/get-csteamsmessagingconfiguration.md rename to teams/teams-ps/MicrosoftTeams/get-csteamsmessagingconfiguration.md index fc5ad06309..ad55e5e878 100644 --- a/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/get-csteamsmessagingconfiguration.md @@ -1,93 +1,94 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMessagingConfiguration -title: Get-CsTeamsMessagingConfiguration -schema: 2.0.0 ---- - -# Get-CsTeamsMessagingConfiguration - -## SYNOPSIS - -TeamsMessagingConfiguration determines the messaging settings for users. This cmdlet returns your organization's current settings. - -## SYNTAX - -### Identity (Default) - -```powershell -Get-CsTeamsMessagingConfiguration [[-Identity] ] [] -``` - -### Filter - -```powershell -Get-CsTeamsMessagingConfiguration [-Filter ] [] -``` - -## DESCRIPTION - -TeamsMessagingConfiguration determines the messaging settings for users. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Get-CsTeamsMessagingConfiguration -``` - -The command shown in Example 1 returns teams messaging configuration information for the current tenant. - -## PARAMETERS - -### -Filter - -Enables you to use wildcard characters in order to return a collection of tenant messaging configuration settings. Because each tenant is limited to a single, global collection of the messaging configuration settings there is no need to use the Filter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingconfiguration) +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMessagingConfiguration +schema: 2.0.0 +title: Get-CsTeamsMessagingConfiguration +--- + +# Get-CsTeamsMessagingConfiguration + +## SYNOPSIS + +TeamsMessagingConfiguration determines the messaging settings for users. This cmdlet returns your organization's current settings. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsMessagingConfiguration [[-Identity] ] [] +``` + +### Filter + +```powershell +Get-CsTeamsMessagingConfiguration [-Filter ] [] +``` + +## DESCRIPTION + +TeamsMessagingConfiguration determines the messaging settings for users. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsMessagingConfiguration +``` + +The command shown in Example 1 returns teams messaging configuration information for the current tenant. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters in order to return a collection of tenant messaging configuration settings. Because each tenant is limited to a single, global collection of the messaging configuration settings there is no need to use the Filter parameter. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md b/teams/teams-ps/MicrosoftTeams/set-csteamsmessagingconfiguration.md similarity index 95% rename from teams/teams-ps/teams/set-csteamsmessagingconfiguration.md rename to teams/teams-ps/MicrosoftTeams/set-csteamsmessagingconfiguration.md index 79f4c96eb3..088aca1443 100644 --- a/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md +++ b/teams/teams-ps/MicrosoftTeams/set-csteamsmessagingconfiguration.md @@ -1,289 +1,290 @@ ---- -external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMessagingConfiguration -title: Set-CsTeamsMessagingConfiguration -schema: 2.0.0 ---- - -# Set-CsTeamsMessagingConfiguration - -## SYNOPSIS - -The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. - -## SYNTAX - -```powershell -Set-CsTeamsMessagingConfiguration [-Identity] - [-Confirm] - [-CustomEmojis ] - [-EnableInOrganizationChatControl ] - [-EnableVideoMessageCaptions ] - [-FileTypeCheck ] - [-Force] - [-MessagingNotes ] - [-UrlReputationCheck ] - [-ContentBasedPhishingCheck ] - [-ReportIncorrectSecurityDetections] - [-WhatIf] - [] -``` - -## DESCRIPTION - -TeamsMessagingConfiguration determines the messaging settings for the users in your tenant. This cmdlet lets you update the user messaging options you'd like to enable in your organization. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsMessagingConfiguration -CustomEmojis $False -``` - -The command shown in example 1 disables custom emojis within Teams. - -## PARAMETERS - -### -Identity - -Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomEmojis - -This setting enables/disables the use of custom emojis and reactions across the whole tenant. Upon enablement, admins and/or users can define a user group that is allowed. -Possible Values: True, False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableInOrganizationChatControl - -This setting determines if chat regulation for internal communication in tenant is allowed. -Possible Values: True, False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableVideoMessageCaptions - - This setting determines if closed captions will be displayed, for Teams Video Clips, during playback. - Possible values: True, False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileTypeCheck - ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -This setting determines if FileType check in teams messaging across the whole tenant - -Possible Values: -- Enabled -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessagingNotes - -This setting enables/disables MessagingNotes integration across the whole tenant. Possible Values: Disabled, Enabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlReputationCheck - ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -This setting determines if UrlReputationCheck check in teams messaging across the whole tenant - -Possible Values: -- Enabled -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentBasedPhishingCheck - ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -This setting determines if Content Based Phishing Check in teams messaging across the whole tenant - -Possible Values: -- Enabled -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportIncorrectSecurityDetections - ->[!NOTE] ->This feature has not been released yet and will have no changes if it is enabled or disabled. - -This setting determines if Report Incorrect Security Detections is enabled in teams messaging across the whole tenant - -Possible Values: -- Enabled -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingconfiguration) +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Locale: en-US +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMessagingConfiguration +schema: 2.0.0 +title: Set-CsTeamsMessagingConfiguration +--- + +# Set-CsTeamsMessagingConfiguration + +## SYNOPSIS + +The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. + +## SYNTAX + +```powershell +Set-CsTeamsMessagingConfiguration [-Identity] + [-Confirm] + [-CustomEmojis ] + [-EnableInOrganizationChatControl ] + [-EnableVideoMessageCaptions ] + [-FileTypeCheck ] + [-Force] + [-MessagingNotes ] + [-UrlReputationCheck ] + [-ContentBasedPhishingCheck ] + [-ReportIncorrectSecurityDetections] + [-WhatIf] + [] +``` + +## DESCRIPTION + +TeamsMessagingConfiguration determines the messaging settings for the users in your tenant. This cmdlet lets you update the user messaging options you'd like to enable in your organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsMessagingConfiguration -CustomEmojis $False +``` + +The command shown in example 1 disables custom emojis within Teams. + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentBasedPhishingCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if Content Based Phishing Check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomEmojis + +This setting enables/disables the use of custom emojis and reactions across the whole tenant. Upon enablement, admins and/or users can define a user group that is allowed. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInOrganizationChatControl + +This setting determines if chat regulation for internal communication in tenant is allowed. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableVideoMessageCaptions + + This setting determines if closed captions will be displayed, for Teams Video Clips, during playback. + Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileTypeCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if FileType check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingNotes + +This setting enables/disables MessagingNotes integration across the whole tenant. Possible Values: Disabled, Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportIncorrectSecurityDetections + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if Report Incorrect Security Detections is enabled in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlReputationCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if UrlReputationCheck check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/Add-TeamsAppInstallation.md b/teams/teams-ps/teams/Add-TeamsAppInstallation.md deleted file mode 100644 index 031a1aa094..0000000000 --- a/teams/teams-ps/teams/Add-TeamsAppInstallation.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/add-teamsappinstallation -title: Add-TeamsAppInstallation -schema: 2.0.0 ---- - -# Add-TeamsAppInstallation - -## SYNOPSIS -Add a Teams App to Microsoft Teams. - -## SYNTAX - -### TeamScope -``` -Add-TeamsAppInstallation -AppId -TeamId [-Permissions ] [] -``` - -### UserScope -``` -Add-TeamsAppInstallation -AppId -UserId [-Permissions ] [] -``` - -## DESCRIPTION -Add a Teams App to Microsoft Teams. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example adds a Teams App to Microsoft Teams. - -### Example 2 -```powershell -PS C:\> Add-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -Permissions "TeamSettings.Read.Group ChannelMessage.Read.Group" -``` - -This example adds a Teams App to Microsoft Teams with RSC Permissions. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Permissions -RSC permissions for the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md deleted file mode 100644 index 84d184eb9d..0000000000 --- a/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -title: Disable-CsTeamsShiftsConnectionErrorReport -author: gucsun -ms.author: gucsun -manager: navinth -online version: https://learn.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport -schema: 2.0.0 ---- - -# Disable-CsTeamsShiftsConnectionErrorReport - -## SYNOPSIS - -**Note:** This cmdlet is currently in public preview. - -This cmdlet disables an error report. - -## SYNTAX - -``` -Disable-CsTeamsShiftsConnectionErrorReport -ErrorReportId [] -``` - -## DESCRIPTION - -This cmdlet disables an error report. All available instances can be found by running [Get-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Disable-CsTeamsShiftsConnectionErrorReport -ErrorReportId 18b3e490-e6ed-4c2e-9925-47e36609dff3 -``` - -Disables the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. - -## PARAMETERS - -### -ErrorReportId - -The ID of the error report that you want to disable. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport) diff --git a/teams/teams-ps/teams/Get-CsDialPlan.md b/teams/teams-ps/teams/Get-CsDialPlan.md deleted file mode 100644 index f7d347abb0..0000000000 --- a/teams/teams-ps/teams/Get-CsDialPlan.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csdialplan -applicable: Microsoft Teams -title: Get-CsDialPlan -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: rogupta ---- - -# Get-CsDialPlan - -## SYNOPSIS -Returns information about the dial plans used in your organization. -This cmdlet was introduced in Lync Server 2010. - -## SYNTAX - -### Identity (Default) -``` -Get-CsDialPlan [-Tenant ] [[-Identity] ] [-LocalStore] [] -``` - -### Filter -``` -Get-CsDialPlan [-Tenant ] [-Filter ] [-LocalStore] [] -``` - -## DESCRIPTION -This cmdlet returns information about one or more dial plans (also known as a location profiles) in an organization. -Dial plans provide information required to enable Enterprise Voice users to make telephone calls. -Dial plans are also used by the Conferencing Attendant application for dial-in conferencing. -A dial plan determines such things as which normalization rules are applied and whether a prefix must be dialed for external calls. - -Note: You can use the Get-CsDialPlan cmdlet to retrieve specific information about the normalization rules of a dial plan, but if that's the only dial plan information you need, you can also use the Get-CsVoiceNormalizationRule cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsDialPlan -``` - -Example 1 returns a collection of all the dial plans configured for use in your organization; this is done by calling the Get-CsDialPlan cmdlet without any additional parameters. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsDialPlan -Identity RedmondDialPlan -``` - -In Example 2, the Identity parameter is used to limit the retrieved data to dial plans that have a per-user dial plan with the Identity RedmondDialPlan. -Because identities must be unique, this command will return only the specified dial plan. - -### -------------------------- Example 3 -------------------------- -``` -Get-CsDialPlan -Identity site:Redmond -``` - -Example 3 is identical to Example 2 except that instead of retrieving a per-user dial plan, we're retrieving a dial plan assigned to a site. -We do that by specifying the value site: followed by the site name (in this case Redmond) of the site we want to retrieve. - -### -------------------------- Example 4 -------------------------- -``` -Get-CsDialPlan -Filter tag:* -``` - -This example uses the Filter parameter to return a collection of all the dial plans that have been configured at the per-user scope. -(Settings configured at the per-user, or tag, scope can be directly assigned to users and groups.) The wildcard string tag:* instructs the cmdlet to return only those dial plans that have an identity beginning with the string value tag:, which identifies a dial plan as a per-user dial plan. - -### -------------------------- Example 5 -------------------------- -``` -Get-CsDialPlan | Select-Object -ExpandProperty NormalizationRules -``` - -This example displays the normalization rules used by the dial plans configured for use in your organization. -Because the NormalizationRules property consists of an array of objects, the complete set of normalization rules is typically not displayed on screen. -To see all of these rules, this sample command first uses the Get-CsDialPlan cmdlet to retrieve a collection of all the dial plans. -That collection is then piped to the Select-Object cmdlet; in turn, the ExpandProperty parameter of the Select-Object cmdlet is used to "expand" the values found in the NormalizationRules property. -Expanding the values simply means that all the normalization rules will be listed out individually on the screen, the same output that would be seen if the Get-CsVoiceNormalizationRule cmdlet had been called. - -### -------------------------- Example 6 -------------------------- -``` -Get-CsDialPlan | Where-Object {$_.Description -match "Redmond"} -``` - -In Example 6, the Get-CsDialPlan cmdlet and the Where-Object cmdlet are used to retrieve a collection of all the dial plans that include the word Redmond in their description. -To do this, the command first uses the Get-CsDialPlan cmdlet to retrieve all the dial plans. -That collection is then piped to the Where-Object cmdlet, which applies a filter that limits the returned data to profiles that have the word Redmond somewhere in their Description. - -## PARAMETERS - -### -Identity -The unique identifier designating the scope, and for per-user scope a name, to identify the dial plan you want to retrieve. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Performs a wildcard search that allows you to narrow down your results to only dial plans with identities that match the given wildcard string. - -```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -Retrieves the dial plan information from the local replica of the Central Management store, rather than the Central Management store itself. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -{{Fill Tenant Description}} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile - -## NOTES - -## RELATED LINKS - -[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md deleted file mode 100644 index f5161eb3d9..0000000000 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantAppointmentBookingFlow.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsMainlineAttendantAppointmentBookingFlow -applicable: Microsoft Teams -title: Get-CsMainlineAttendantAppointmentBookingFlow -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Get-CsMainlineAttendantAppointmentBookingFlow - -## SYNOPSIS -The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet returns the identified Mainline attendant appointment booking flow. - -## SYNTAX - -``` -Get-CsMainlineAttendantAppointmentBookingFlow [-Identity ] [-Tenant ] [-First ] [-Skip ] [-ExcludeContent ] [-Sort ] [-Descending ] [-NameFilter ] [] -``` - -## DESCRIPTION -The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet lets you retrieve information about the Mainline attendant appointment booking flows n your organization. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsMainlineAttendantAppointmentBookingFlow -``` - -This example gets the first 100 Mainline attendant appointment booking flows in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsMainlineAttendantAppointmentBookingFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 -``` - -This example gets the Mainline attendant appointment booking flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no appointment booking flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. - -## PARAMETERS - -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -The First parameter gets the first N appointment flows, up to a maximum of 100 at a time. -When not specified, the default behavior is to return the first 100 appointment flows. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. -If a number greater than 100 is supplied, the request will fail. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: 100 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -The Skip parameter skips the first N appointment flows. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeContent -The ExcludeContent parameter only displays the Name and Id of the appointment flow. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The Sort parameter specifies the property used to sort. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: Name -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Descending -The Descending parameter sorts appointment booking flows in descending order - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NameFilter -The NameFilter parameter returns appointment booking flows where the name contains specified string - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Identity -Represents the unique identifier of an appointment booking flow. - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md deleted file mode 100644 index 3b01b0dd8f..0000000000 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantFlow.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/get-csmainlineattendantflow -applicable: Microsoft Teams -title: Get-CsMainlineAttendantFlow -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# Get-CsMainlineAttendantFlow - -## SYNOPSIS -Creates new Call Queue in your Skype for Business Online organization. - -## SYNTAX - -``` -Get-CsMainlineAttendantFlow [-MaConfigId ] [-Type ] [-FlowId ] [-Tenant ] [] -``` - -## DESCRIPTION -The Get-CsMainlineAttendantFlow cmdlet returns information about the Mainline Attendant flows configured in your organization. - -> [!CAUTION] -> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. - -## EXAMPLES - -### Example 1 -``` -Get-CsMainlineAttendantFlow -``` - -This example will list all the Mainline Attendant flows in the tenant. - -### Example 2 -``` -Get-CsMainlineAttendantFlow -MaConfig 0b31bbe5-e2a0-4117-9b6f-956bca6023f8 -``` - -This example will list all the Mainline Attendant flows associated with the specific configuration id. - -### Example 3 -``` -Get-CsMainlineAttendantFlow -Type Type 1 | Type 2 -``` - -This example will list all the Mainline Attendant flows with the specified type. - -### Example 4 -``` -Get-CsMainlineAttendantFlow -FlowId 956bca6-e2a0-4117-9b6f-023f80b31bbe5 -``` - -This example will list the Mainline Attendant flow with the specified flow id. - -## PARAMETERS - -### -MaConfigId -The Mainline Attendant configuration Id - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Mainline Attendant flow type - -PARAMVALUE: Appointment | QuestionAndAnswer - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FlowId -The Mainline Attendant flow id - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md deleted file mode 100644 index fcaf4470cd..0000000000 --- a/teams/teams-ps/teams/Get-CsMainlineAttendantQuestionAnswerFlow.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsMainlineAttendantQuestionAnswerFlow -applicable: Microsoft Teams -title: Get-CsMainlineAttendantQuestionAnswerFlow -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Get-CsMainlineAttendantQuestionAnswerFlow - -## SYNOPSIS -The Get-CsMainlineAttendantQuestionAnswerFlow cmdlet returns the identified Mainline attendant question and answer flow. - -## SYNTAX - -``` -Get-CsMainlineAttendantQuestionAnswerFlow [-Identity ] [-Tenant ] [-First ] [-Skip ] [-ExcludeContent ] [-Sort ] [-Descending ] [-NameFilter ] [] -``` - -## DESCRIPTION -The Get-CsMainlineAttendantQuestionAnswerFlow cmdlet lets you retrieve information about the Mainline attendant question and answer flows n your organization. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsMainlineAttendantQuestionAnswerFlow -``` - -This example gets the first 100 Mainline attendant question and answer flows in the organization. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsMainlineAttendantQuestionAnswerFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 -``` - -This example gets the Mainline attendant question and answer flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no question and answer flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. - -## PARAMETERS - -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -The First parameter gets the first N appointment flows, up to a maximum of 100 at a time. -When not specified, the default behavior is to return the first 100 question and answer flows. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. -If a number greater than 100 is supplied, the request will fail. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: 100 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -The Skip parameter skips the first N appointment flows. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeContent -The ExcludeContent parameter only displays the Name and Id of the question and answer flow. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sort -The Sort parameter specifies the property used to sort. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: Name -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Descending -The Descending parameter sorts appointment booking flows in descending order - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NameFilter -The NameFilter parameter returns question and answer booking flows where the name contains specified string - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Identity -Represents the unique identifier of a question and answer booking flow. - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md b/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md deleted file mode 100644 index 445cec3c6a..0000000000 --- a/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -title: Get-LicenseReportForChangeNotificationSubscription -author: serdarsoysal -ms.author: serdars -manager: alagra -online version: https://learn.microsoft.com/powershell/module/teams/get-licensereportforchangenotificationsubscription -schema: 2.0.0 ---- - -# Get-LicenseReportForChangeNotificationSubscription - -## SYNOPSIS - -This cmdlet tells whether a user has the required license to export their messages via [change notification subscription](https://learn.microsoft.com/graph/teams-licenses). - -## SYNTAX - -``` -Get-LicenseReportForChangeNotificationSubscription [-Period] [] -``` - -## DESCRIPTION - -This cmdlet supports retrieving the total number of messages sent by a user in chat/channel and whether a user has the required license(s) to send change notification events when subscribed for chat or channel messages. For more details, please review [Licenses for subscribing to chat messages](https://learn.microsoft.com/graph/teams-licenses). -This cmdlet is currently supported in preview version only. - -## EXAMPLES - -### Example -```powershell -PS C:\> Get-LicenseReportForChangeNotificationSubscription -Period 7 -``` - -Returns license info and total messages sent by users in the last 7 days. - -## PARAMETERS - -### -Period - -Number of days prior to today. Acceptable values are 7, 30, 90 and 180. - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamFunSettings.md b/teams/teams-ps/teams/Get-TeamFunSettings.md deleted file mode 100644 index 00fb19db53..0000000000 --- a/teams/teams-ps/teams/Get-TeamFunSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamFunSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teamfunsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamFunSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's fun settings, run Get-Team. - -Gets a team's fun settings. - -## SYNTAX - -``` -Get-TeamFunSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamFunSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamGuestSettings.md b/teams/teams-ps/teams/Get-TeamGuestSettings.md deleted file mode 100644 index 91b260b35c..0000000000 --- a/teams/teams-ps/teams/Get-TeamGuestSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamGuestSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teamguestsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamGuestSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's guest settings, run Get-Team. - -Gets Team guest settings. - -## SYNTAX - -``` -Get-TeamGuestSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamGuestSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamMemberSettings.md b/teams/teams-ps/teams/Get-TeamMemberSettings.md deleted file mode 100644 index f2b4df4491..0000000000 --- a/teams/teams-ps/teams/Get-TeamMemberSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamMemberSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teammembersettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamMemberSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's member settings, run Get-Team. - -Gets team member settings. - -## SYNTAX - -``` -Get-TeamMemberSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamMemberSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamMessagingSettings.md b/teams/teams-ps/teams/Get-TeamMessagingSettings.md deleted file mode 100644 index 75cbd47356..0000000000 --- a/teams/teams-ps/teams/Get-TeamMessagingSettings.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Get-TeamMessagingSettings -online version: https://learn.microsoft.com/powershell/module/teams/get-teammessagingsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamMessagingSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To retrieve a Team's messaging settings, run Get-Team. - -Gets team messaging settings. - -## SYNTAX - -``` -Get-TeamMessagingSettings -GroupId -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-TeamMessagingSettings -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-TeamsAppInstallation.md b/teams/teams-ps/teams/Get-TeamsAppInstallation.md deleted file mode 100644 index 39ef59a41c..0000000000 --- a/teams/teams-ps/teams/Get-TeamsAppInstallation.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/get-teamsappinstallation -title: Get-TeamsAppInstallation -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Get-TeamsAppInstallation - -## SYNOPSIS -Get a Teams App installed in Microsoft Teams. - -## SYNTAX - -### TeamScope (Default) -``` -Get-TeamsAppInstallation -TeamId [-AppInstallationId ] [-AppId ] [] -``` - -### UserScope -``` -Get-TeamsAppInstallation -UserId [-AppInstallationId ] [-AppId ] [] -``` - -## DESCRIPTION -Get a Teams App installed in Microsoft Teams. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example gets a Teams App specifying its AppId and the TeamId. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AppInstallationId -Installation identifier of the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md b/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md deleted file mode 100644 index e85a10218d..0000000000 --- a/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-cscloudmeetingpolicy -applicable: Microsoft Teams -title: Grant-CsCloudMeetingPolicy -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Grant-CsCloudMeetingPolicy - -## SYNOPSIS -Grants Skype Meetings polices for a user. - -## SYNTAX - -``` -Grant-CsCloudMeetingPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-Identity] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Grant-CsCloudMeetingPolicy cmdlet enables or disables automatic scheduling of Skype Meetings features for a specified user. -The default is disabled. - -To enable automatic scheduling for all users in a tenant, use the Set-CsCloudMeetingPolicy cmdlet. - -Note that the policies to use this cmdlet are not available unless the Set-CsCloudMeetingConfiguration cmdlet has been run to enable Skype Meetings polices for a tenant. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -Grant-CsCloudMeetingPolicy -PolicyName AutoScheduleEnabled -Identity "JaneC" -``` - -This example enables Skype Meetings automatic scheduling for a user. - -## PARAMETERS - -### -Identity -Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: `-Identity "SeattlePSTN".` - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the policy for all users automatic Skype Meeting Ready scheduling. -Can be either AutoScheduleEnabled or AutoScheduleDisabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -@{Text=} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308".` -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online, you do not have to include the Tenant parameter. -The tenant ID will be determined by your connection and credentials. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md b/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md deleted file mode 100644 index d587ae4503..0000000000 --- a/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/teams/grant-csexternalusercommunicationpolicy -applicable: Microsoft Teams -title: Grant-CsExternalUserCommunicationPolicy -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Grant-CsExternalUserCommunicationPolicy - -## SYNOPSIS -Provide the topic introduction here. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsExternalUserCommunicationPolicy [[-Identity] ] [-PolicyName] - [-Tenant ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsExternalUserCommunicationPolicy [-PolicyName] [-Tenant ] - [-DomainController ] [-PassThru] [-Global] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - -## PARAMETERS - -### -PolicyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -PARAMVALUE: UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md deleted file mode 100644 index f55a7ea3db..0000000000 --- a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlow.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantappointmentbookingflow -applicable: Microsoft Teams -title: New-CsMainlineAttendantAppointmentBookingFlow -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# New-CsMainlineAttendantAppointmentBookingFlow - -## SYNOPSIS -Creates new Mainline Attendant appointment booking flow - -## SYNTAX - -``` -New-CsMainlineAttendantAppointmentBookingFlow -Name -Description -CallerAuthenticationMethod -ApiAuthenticationType -ApiDefinitions [-Tenant ] [] -``` - -## DESCRIPTION -The New-CsMainlineAttendantAppointmentBookingFlow cmdlet creates a new appointment booking connection that can be used with Mainline Attendant - -> [!CAUTION] -> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. - -## EXAMPLES - - -## PARAMETERS - -### -Name -The name of the appointment booking flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for the appointment booking flow - -Limit: 500 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallerAuthenticationMethod -The method by which the caller is authenticated - -PARAVALUES: sms | email | verification_link | voiceprint | user_details - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiAuthenticationType -The method of authentication used by the API - -PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiDefinitions -The parameters used by the API - -For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md deleted file mode 100644 index 6403f8f04b..0000000000 --- a/teams/teams-ps/teams/New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantappointmentbookingflowapidefinitionsJSON -applicable: Microsoft Teams -title: New-CsMainLineAttendantAppointmentBookingFlowApiDefinitionsJSON -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# New-CsMainlineAttendantAppointmentBookingFlow -ApiDefinition JSON Example - -## SYNOPSIS -The [New-CsMainlineAttendantAppointmentBookingFlow](./New-CsMainlineAttendantAppointmentBookingFlow.md) -ApiDefinitions requires a JSON formatted response. - -## SYNTAX - -``` -{ - "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { // Description of the query string parameters in the endpoint - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer ", // replace with an expected value - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - - "response" : { // Response to 200 range of codes - "token" : "" // this token will be used for APIs with "bearer_token_dynamic" auth type - } - }, - - "getCallerDetails" : [ // Can specify multiple endpoints below to get caller details by phone number, ID, email, etc. - { - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { // Definition of the query string parameters in the endpoint - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", // replace with an expected value. will be replaced by the response to generateAuthToken() - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - - "body" : { // Sent as JSON payload - "in_parameter1" : "", - "in_parameter2" : "" - }, - - "response" : { // Response to 200 range of codes - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" - } - }, - - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" - }, - - "body" : { - "in_parameter1" : "", - "in_parameter2" : "" - }, - - "response" : { - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" - } - } - ], - - "initiateCallerAuthentication" : [ // for SMS/email code, verification link - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - - "body" : { - "in_parameter1" : "", // phone number, user ID, etc - "in_parameter2" : "" // session ID - }, - - "response" : { - "out_parameter1" : "", // success/failure - } - } - ], - - "authenticateCaller" : [ // for SMS/email code, voiceprint, verification link, caller details - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - - "body" : { - "in_parameter1" : "", // phone number, user ID, etc - "in_parameter2" : "", // session ID - "in_parameter3" : "", // VoicePrint payload or code - }, - - "response" : { - "out_parameter1" : "", // success/failure - } - } - ], - - "getAvailableAppointmentTimeslots" : [ - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" - }, - - "body" : { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "in_parameter3" : "", // optional parameters like appointment type, doctor name, etc - "in_parameter4" : "", // number of results - }, - - "response" : { - "time_slots" : [ - { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "opt_parameter1" : "", // optional parameters like appointment type, doctor name, etc - }, - - { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "opt_parameter1" : "", // optional parameters like appointment type, doctor name, etc - } - ], - - "out_parameter3" : "", - "out_parameter4" : "", - } - } - ], - - "bookAppointment" : [ - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" - }, - - "body" : { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "in_parameter3" : "", // optional parameters like appointment type, doctor name, etc - "in_parameter4" : "", // patient id - }, - - "response" : { - "out_parameter1" : "", // success/failure - "out_parameter2" : "", - } - } - ], - - "getUpcomingAppointments" : [ - { - "endpoint" : "", - "method_type": "GET" or "PUT" or "POST", - "description" : "", - - "query_strings" : { - "parameter1" : "", - "parameter2" : "" - }, - - "headers : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", - "X-API-Key" : "API-Key" - }, - - "body" : { - "in_parameter1" : "", // phone number, user ID, etc - "in_parameter2" : "" - }, - - "response" : { - "time_slots" : [ - { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "opt_parameter1" : "" // optional parameters like appointment type, doctor name, etc - }, - - { - "start_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "end_time" : "YYYY-MM-DDTHH:mm:ss.sssZ" // Timezone as configured on the AA config in ISO 8601 standard - "opt_parameter1" : "" // optional parameters like appointment type, doctor name, etc - } - ], - - "out_parameter3" : "", - "out_parameter4" : "" - } - } - ] -} -``` - -## PARAMETERS - -### -ApiDefinitions -The parameters used by the API - see the JSON example above. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: Yes -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - - - diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md deleted file mode 100644 index 6b178a7e40..0000000000 --- a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlow.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/New-CsMainlineAttendantQuestionAnswerFlow -applicable: Microsoft Teams -title: New-CsMainlineAttendantQuestionAnswerFlow -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# New-CsMainlineAttendantQuestionAnswerFlow - -## SYNOPSIS -Creates new Mainline Attendant question and answer (FAQ) flow - -## SYNTAX - -``` -New-CsMainlineAttendantQuestionAnswerFlow -Name -Description -ApiAuthenticationType -KnowledgeBase [-Tenant ] [] -``` - -## DESCRIPTION -The New-CsMainlineAttendantQuestionAnswerFlow cmdlet creates a question and answer connection that can be used with Mainline Attendant - -> [!CAUTION] -> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. - -## EXAMPLES - - -## PARAMETERS - -### -Name -The name of the question and answer flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for the question and answer flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiAuthenticationType -The method of authentication used by the API - -PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KnowledgeBase -The knowledge base definition - -The parameters used by the API - -For an example, see [New-CsMainlineAttendantQuestionAnswerFlow -KnowledgeBase](./New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md b/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md deleted file mode 100644 index 94939608d0..0000000000 --- a/teams/teams-ps/teams/New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantquestionanswerflowknowledgebaseJSON -applicable: Microsoft Teams -title: New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# New-CsMainlineAttendantQuestionAnswerFlow -KnowledgeBase JSON Example - -## SYNOPSIS -The [New-CsMainlineAttendantQuestionAnswerFlow](./New-CsMainlineAttendantQuestionAnswerFlow.md) -Knowledge requires a path to a JSON formatted response. - -## SYNTAX - -``` -[ - { - "address_type" : "local_file", - "document_address" : "", // provide full path to the local address - "description" : "" - - }, - { - "address_type" : "webpage", - "document_address" : "", // provide full path to the webpage - "description" : "" - - }, - { - "address_type" : "api_endpoint", - "description" : "", - "api_specification" : { - "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= - "method_type": "GET" or "PUT" or "POST", - "description" : "", - "query_strings" : { // Description of the query string parameters in the endpoint - "parameter1" : "", - "parameter2" : "" - }, - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer ", // replace with an expected value - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - "response" : { // Response to 200 range of codes - "token" : "" // this token will be used for APIs with "bearer_token_dynamic" auth type - } - }, - "getResults1" : { - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= - "method_type": "GET" or "PUT" or "POST", - "description" : "", - "query_strings" : { // Definition of the query string parameters in the endpoint - "parameter1" : "", - "parameter2" : "" - }, - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", // replace with an expected value. will be replaced by the response to generateAuthToken() - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - "body" : { // Sent as JSON payload - "in_parameter1" : "", - "in_parameter2" : "" - }, - "response" : { // Response to 200 range of codes - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" - } - }, - "getResults2" : { - "endpoint" : "", // For example, https://www.contoso.com/home?parameter1=¶meter2= - "method_type": "GET" or "PUT" or "POST" - "description" : "", - "query_strings" : { // Definition of the query string parameters in the endpoint - "parameter1" : "", - "parameter2" : "" - }, - "headers" : { - "Authorization" : "Basic " or "api-key " or "Bearer " or "Bearer ", // replace with an expected value. will be replaced by the response to generateAuthToken() - "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. - }, - "body" : { // Sent as JSON payload - "in_parameter1" : "", - "in_parameter2" : "" - }, - "response" : { // Response to 200 range of codes - "out_parameter1" : "", - "out_parameter2" : "", - "out_parameter3" : "" - } - } - } - } -] -``` - -## PARAMETERS - -### -Knowledgebase -The parameters used by the Knowledgebase - see the JSON example above. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: Yes -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - - - diff --git a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md deleted file mode 100644 index a1cde5d5cf..0000000000 --- a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml -Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version:online version: https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder -applicable: Microsoft Teams -title: New-CsOnlineTelephoneNumberReleaseOrder -author: pavellatif -ms.author: pavellatif -ms.reviewer: pavellatif -manager: roykuntz -schema: 2.0.0 ---- - -# New-CsOnlineTelephoneNumberReleaseOrder - -## SYNOPSIS -This cmdlet creates a request to release telephone numbers from Microsoft Teams telephone number management inventory. - -## SYNTAX - -``` -New-CsOnlineTelephoneNumberReleaseOrder [-TelephoneNumber ] [-StartingNumber ] [-EndingNumber ] [-FileContent ] [] -``` - -## DESCRIPTION -This cmdlet releases existing telephone numbers from Microsoft Teams telephone number management inventory. Once released the phone numbers will not be visible in Teams PowerShell as acquired telephone numbers. A maximum of 1,000 phone numbers can be released at a time. If more than 1,000 numbers need to be released, the requests should be divided into multiple increments of up to 1,000 numbers. - -The cmdlet is an asynchronous operation and will return an OrderId as output. You can use the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to check the status of the OrderId, including any error or warning messages that might result from the operation: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789" -cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 -``` - -In this example, a telephone number "+123456789" is being released from Microsoft Teams telephone number management inventory. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. - -### Example 2 -```powershell -PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789,+134567890,+145678901" -cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 -``` - -In this example, a list of telephone numbers are being released from Microsoft Teams telephone number management. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. - -### Example 3 -```powershell -PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -StartingNumber "+12000000" -EndingNumber "+12000009" -cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 -``` - -In this example, a range of telephone numbers from "+12000000" to "+12000009" are being released from Microsoft Teams telephone number management. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. - -### Example 4 -```powershell -PS C:\> $drlist = [System.IO.File]::ReadAllBytes("C:\Users\testuser\DrNumber.csv") -PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -FileContent $drlist -cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 -``` - -In this example, the content of a file with a list of telephone numbers are being released via file upload. The file should be in Comma Separated Values (CSV) file format and should only contain the list of telephone numbers to be released. The New-CsOnlineTelephoneNumberReleaseOrder cmdlet is only used to pass the content. To read the output of this cmdlet and retrieve the status of your order, you can use OrderId with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet : `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. - -## PARAMETERS - -### -TelephoneNumber -This is the telephone number you wish to release from your tenant in Microsoft Teams telephone number management inventory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartingNumber -This is the starting number of a range of telephone number you wish to release from your tenant in Microsoft Teams telephone number management inventory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndingNumber -This is the ending number of a range of telephone number you wish to release from your tenant in Microsoft Teams telephone number management inventory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileContent -This is the content of a .csv file that includes the telephone numbers to be released from the Microsoft Teams telephone number management inventory. This parameter can be used to release up to 1,000 numbers at a time. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.String - -## NOTES -The cmdlet is available in Teams PowerShell module 6.7.1 or later. - -The cmdlet is only available in commercial and GCC cloud instances. - -## RELATED LINKS -[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) -[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder) \ No newline at end of file diff --git a/teams/teams-ps/teams/New-CsTeamsCustomBannerText b/teams/teams-ps/teams/New-CsTeamsCustomBannerText deleted file mode 100644 index af23fbf760..0000000000 --- a/teams/teams-ps/teams/New-CsTeamsCustomBannerText +++ /dev/null @@ -1,95 +0,0 @@ ---- -Module Name: MicrosoftTeams -title: New-CsTeamsCustomBannerText -author: saleens7 -ms.author: wblocker -online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsCustomBannerText -schema: 2.0.0 ---- - -# New-CsTeamsCustomBannerText - -## SYNOPSIS - -Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. - -## SYNTAX - -### Identity (Default) -``` -New-CsTeamsCustomBannerText [[-Id] ] [] -``` - -## DESCRIPTION - -Creates a single instance of a custom banner text. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> New-CsTeamsCustomBannerText -Identity CustomText -``` - -Creates an instance of TeamsCustomBannerText with the name CustomText. - -## PARAMETERS - -### -Id -The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. - -```yaml -Type: Guid -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Text -The text that the tenant admin would like to set in the policy. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description that the tenant admin would like to set to identify what this text represents. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) - -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) - -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/New-CsTeamsPinnedApp.md b/teams/teams-ps/teams/New-CsTeamsPinnedApp.md deleted file mode 100644 index 6c96bf3b11..0000000000 --- a/teams/teams-ps/teams/New-CsTeamsPinnedApp.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -Module Name: tmp_1cmcv0jw.3l2 -online version: https://learn.microsoft.com/powershell/module/teams/new-csteamspinnedapp -title: New-CsTeamsPinnedApp -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# New-CsTeamsPinnedApp - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -### Identity (Default) -``` -New-CsTeamsPinnedApp [-Tenant ] -Order [-Priority ] [-Identity] - [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey -``` -New-CsTeamsPinnedApp [-Tenant ] -Parent -Id -Order [-Priority ] - [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally not provided - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Do not use. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do not use. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Order -Do not use. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parent -Do not use. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Do not use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Do not use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md deleted file mode 100644 index e38af8fd7a..0000000000 --- a/teams/teams-ps/teams/Remove-CsMainlineAttendantAppointmentBookingFlow.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsMainlineAttendantAppointmentBookingFlow -applicable: Microsoft Teams -title: Remove-CsMainlineAttendantAppointmentBookingFlow -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Remove-CsMainlineAttendantAppointmentBookingFlow - -## SYNOPSIS -The Remove-CsMainlineAttendantAppointmentBookingFlow cmdlet deletes an existing Mainline attendant appointment booking flow. - -## SYNTAX - -``` -Remove-CsMainlineAttendantAppointmentBookingFlow -Identity [-Tenant ] [] -``` - -## DESCRIPTION -The Remove-CsMainlineAttendantAppointmentBookingFlow cmdlet deletes an existing Mainline attendant appointment booking flow. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsMainlineAttendantAppointmentBookingFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 -``` - -This example removes the Mainline attendant appointment booking flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no appointment booking flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. - -## PARAMETERS - -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Identity -Represents the unique identifier of a Mainline attendant appointment booking flow. - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md deleted file mode 100644 index d57095be09..0000000000 --- a/teams/teams-ps/teams/Remove-CsMainlineAttendantQuestionAnswerFlow.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsMainlineAttendantQuestionAnswerFlow -applicable: Microsoft Teams -title: Remove-CsMainlineAttendantQuestionAnswerFlow -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Remove-CsMainlineAttendantQuestionAnswerFlow - -## SYNOPSIS -The Remove-CsMainlineAttendantQuestionAnswerFlow cmdlet deletes an existing Mainline attendant question and answer flow. - -## SYNTAX - -``` -Remove-CsMainlineAttendantQuestionAnswerFlow -Identity [-Tenant ] [] -``` - -## DESCRIPTION -The Remove-CsMainlineAttendantQuestionAnswerFlow cmdlet deletes an existing Mainline attendant question and answer flow. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsMainlineAttendantQuestionAnswerFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 -``` - -This example removes the Mainline attendant question and answer flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no question and answer flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. - -## PARAMETERS - -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Identity -Represents the unique identifier of a Mainline attendant question and answer flow. - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - diff --git a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText deleted file mode 100644 index 9e9dcd1434..0000000000 --- a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText +++ /dev/null @@ -1,71 +0,0 @@ ---- -Module Name: MicrosoftTeams -title: Remove-CsTeamsCustomBannerText -author: saleens7 -ms.author: wblocker -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText -schema: 2.0.0 ---- - -# Remove-CsTeamsCustomBannerText - -## SYNOPSIS - -Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. - -## SYNTAX - -### Identity (Default) -``` -Remove-CsTeamsCustomBannerText [[-Identity] ] [] -``` - -## DESCRIPTION - -Removes a single instance of custom banner text. - -## EXAMPLES - -### Example 1 -PS C:\> Remove-CsTeamsCustomBannerText -Identity CustomText -``` - -Removes a TeamsCustomBannerText instance with the name "CustomText". - -## PARAMETERS - -### -Identity -Policy instance name (optional). - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) - -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) - -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md b/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md deleted file mode 100644 index 669b830d56..0000000000 --- a/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csteamspinnedapp -applicable: Microsoft Teams -title: Remove-CsTeamsPinnedApp -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Remove-CsTeamsPinnedApp - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -``` -Remove-CsTeamsPinnedApp [[-Identity] ] - [-Confirm] - [-Force] - [-Tenant ] - [-WhatIf] - [] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally not provided - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-TeamsAppInstallation.md b/teams/teams-ps/teams/Remove-TeamsAppInstallation.md deleted file mode 100644 index 36234579ef..0000000000 --- a/teams/teams-ps/teams/Remove-TeamsAppInstallation.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsappinstallation -title: Remove-TeamsAppInstallation -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Remove-TeamsAppInstallation - -## SYNOPSIS -Removes a Teams App installed in Microsoft Teams. - -## SYNTAX - -### TeamScope -``` -Remove-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -TeamId - [] -``` - -### UserScope -``` -Remove-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -UserId - [] -``` - -## DESCRIPTION -Removes a Teams App installed in Microsoft Teams. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example removes a Teams App in Microsoft Teams specifying its AppId and TeamId. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AppInstallationId -Installation identifier of the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md deleted file mode 100644 index c74a4f85ba..0000000000 --- a/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment -title: Set-CsGroupPolicyAssignment -schema: 2.0.0 -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Set-CsGroupPolicyAssignment - -## SYNOPSIS - -> [!NOTE] -> The cmdlet Set-CsGroupPolicyAssignment is not yet available. In the meantime, to change a group policy assignment you can first remove the current policy assignment from the group and then add a new policy assignment. - -## RELATED LINKS - -[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) - -[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) - -[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md deleted file mode 100644 index bef2833cb8..0000000000 --- a/teams/teams-ps/teams/Set-CsMainlineAttendantAppointmentBookingFlow.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsMainlineAttendantAppointmentBookingFlow -applicable: Microsoft Teams -title: Set-CsMainlineAttendantAppointmentBookingFlow -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# Set-CsMainlineAttendantAppointmentBookingFlow - -## SYNOPSIS -Changes an existing Mainline Attendant appointment booking flow - -## SYNTAX - -``` -Set-CsMainlineAttendantAppointmentBookingFlow -Identity [-Name ] [-Description ] [-CallerAuthenticationMethod ] [-ApiAuthenticationType ] [-ApiDefinitions ] [-Tenant ] [] -``` - -## DESCRIPTION -The Set-CsMainlineAttendantAppointmentBookingFlow cmdlet changes an existing appointment booking flow that is used with Mainline Attendant - -> [!CAUTION] -> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. - -## EXAMPLES - - -## PARAMETERS - -### -Identity -The unique Id of the appointment booking flow to change - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the appointment booking flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for the appointment booking flow - -Limit: 500 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallerAuthenticationMethod -The method by which the caller is authenticated - -PARAVALUES: sms | email | verification_link | voiceprint | user_details - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiAuthenticationType -The method of authentication used by the API - -PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiDefinitions -The parameters used by the API - -For an example, see [New-CsMainlineAttendantAppointBookingFlow -ApiDefinitions](./New-CsMainlineAttendantAppointmentBookingFlowApiDefinitionsJSON.md) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - - diff --git a/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md b/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md deleted file mode 100644 index 68cb82c876..0000000000 --- a/teams/teams-ps/teams/Set-CsMainlineAttendantQuestionAnswerFlow.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsMainlineAttendantQuestionAnswerFlow -applicable: Microsoft Teams -title: Set-CsMainlineAttendantQuestionAnswerFlow -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# Set-CsMainlineAttendantQuestionAnswerFlow - -## SYNOPSIS -Changes an existing Mainline Attendant question and answer (FAQ) flow - -## SYNTAX - -``` -Set-CsMainlineAttendantQuestionAnswerFlow -Identity [-Name ] [-Description ] [-ApiAuthenticationType ] [-KnowledgeBase ] [-Tenant ] [] -``` - -## DESCRIPTION -The Set-CsMainlineAttendantQuestionAnswerFlow cmdlet changes an existing question and answer connection that can be used with Mainline Attendant - -> [!CAUTION] -> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. - -## EXAMPLES - - -## PARAMETERS - -### -Identity -The unique identifier for the question and answer flow. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the question and answer flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description for the question and answer flow - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiAuthenticationType -The method of authentication used by the API - -PARAVALUES: basic | api_key | bearer_token_static | bearer_token_dynamic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KnowledgeBase -The knowledge base definition - -The parameters used by the API - -For an example, see [New-CsMainlineAttendantQuestionAnswerFlow -KnowledgeBase](./New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON.md) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS - - diff --git a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md deleted file mode 100644 index 9b13013f9e..0000000000 --- a/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUserDefaultNumber.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csonlinedialinconferencinguserdefaultnumber -applicable: Microsoft Teams -title: Set-CsOnlineDialInConferencingUserDefaultNumber -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Set-CsOnlineDialInConferencingUserDefaultNumber - -## SYNOPSIS -Replace the default toll or toll-free number for all users. - -> [!IMPORTANT] ->This command is being deprecated and will not be available after July 7, 2024. If you are using this command to bulk update Audio conferencing Toll or Toll free phone numbers for users in your organization you can do that using the following alternative methods. -> 1. Use a custom Teams audio conferencing policy - [Audio Conferencing toll-free number policies - Microsoft Teams | Microsoft Learn](https://learn.microsoft.com/en-us/microsoftteams/audio-conferencing-toll-free-numbers-policy) -> 2. Use Set-CsOnlineDialinConferencingUser - [Set-CsOnlineDialInConferencingUser (MicrosoftTeamsPowerShell) | Microsoft Learn](https://learn.microsoft.com/en-us/powershell/module/teams/set-csonlinedialinconferencinguser?view=teams-ps) -> ->If you need assistance in using any of the above methods to achieve what you previously did with the Set-CsOnlineDialInConferencingUserDefaultNumber command, please open a support case with our customer support team. - -## SYNTAX - -### BridgeNameParams -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain ] [-Tenant ] - -BridgeName [-FromNumber ] -ToNumber -NumberType - [-CountryOrRegion ] [-AreaOrState ] [-CapitalOrMajorCity ] [-RescheduleMeetings] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### FilterByUsageLocation -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain ] [-Tenant ] - [-BridgeName ] -BridgeId -ToNumber -NumberType - -CountryOrRegion [-AreaOrState ] [-CapitalOrMajorCity ] [-RescheduleMeetings] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### UniqueBridgeParams -``` -Set-CsOnlineDialInConferencingUserDefaultNumber [-TenantDomain ] [-Tenant ] - -BridgeId -FromNumber -ToNumber -NumberType [-RescheduleMeetings] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineDialInConferencingUserDefaultNumber -FromNumber 14255550100 -ToNumber 14255550101 -NumberType Toll -RescheduleMeetings -BridgeId 9884626f-dcfb-49f4-8025-912f5bc68fdc -``` - -This example replaces the default toll or toll-free number for all users who have the number 14255550100 as a default number to the number 14255550101 and starts the process of rescheduling their meetings. - -## PARAMETERS - -### -BridgeId -The Bridge Id results from running [Get-CsOnlineDialInConferencingBridge](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge) -For example "9884626f-dcfb-49f4-8025-912f5bc68fdc". You can either specify BridgeName or BridgeId. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BridgeName -The Bridge Name results from running [Get-CsOnlineDialInConferencingBridge](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge) -For example "Conference Bridge". You can either specify BridgeName or BridgeId. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -A String representing the Country or Region this Dial In Conferencing Default number belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromNumber -The current default number defined. -$null if no number defined. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberType -The type of number this Dial In Conferencing Default number has. -Valid values are - -- Toll -- TollFree - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToNumber -The new number to assign, without the + sign, for example 14255550101. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AreaOrState -A String representing the Area or State this Dial In Conferencing Default number belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapitalOrMajorCity -A String representing the Capital or Major City this Dial In Conferencing Default number belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RescheduleMeetings -Sends e-mail notifications to Meeting attendees with the updated settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText deleted file mode 100644 index e13c9bf900..0000000000 --- a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText +++ /dev/null @@ -1,93 +0,0 @@ ---- -Module Name: MicrosoftTeams -title: Set-CsTeamsCustomBannerText -author: saleens7 -ms.author: wblocker -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText -schema: 2.0.0 ---- - -# Set-CsTeamsCustomBannerText - -## SYNOPSIS - -Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsCustomBannerText [[-Id] ] [] -``` - -## DESCRIPTION - -Updates a single instance of a custom banner text. - -## EXAMPLES - -### Example 1 -PS C:\> Set-CsTeamsCustomBannerText -Identity CustomText -``` - -Sets the properties of the CustomText instance of TeamsCustomBannerText. - -## PARAMETERS - -### -Id -The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. - -```yaml -Type: Guid -Parameter Sets: Identity -Aliases: -Applicable: Microsoft Teams -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Text -The text that the tenant admin would like to set in the policy. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description that the tenant admin would like to set to identify what this text represents. - -```yaml -Type: String -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) - -[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) - -[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md b/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md deleted file mode 100644 index fac26286e2..0000000000 --- a/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csteamspinnedapp -applicable: Microsoft Teams -title: Set-CsTeamsPinnedApp -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: williamlooney ---- - -# Set-CsTeamsPinnedApp - -## SYNOPSIS -**NOTE**: This cmdlet has been deprecated. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsPinnedApp [-Tenant ] [-Order ] [-Priority ] [[-Identity] ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTeamsPinnedApp [-Tenant ] [-Order ] [-Priority ] [-Instance ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**NOTE**: This cmdlet has been deprecated. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally not provided. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do not use. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Do not use. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Order -Do not use. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Do not use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Do not use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamFunSettings.md b/teams/teams-ps/teams/Set-TeamFunSettings.md deleted file mode 100644 index b0c4f9d5ab..0000000000 --- a/teams/teams-ps/teams/Set-TeamFunSettings.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamFunSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teamfunsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamFunSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Update Giphy, Stickers and Memes settings. - -## SYNTAX - -``` -Set-TeamFunSettings -GroupId [-AllowGiphy ] [-GiphyContentRating ] - [-AllowStickersAndMemes ] [-AllowCustomMemes ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamFunSettings -GroupId 0ebb500c-f5f3-44dd-b155-cc8c4f383e2d -AllowGiphy true -GiphyContentRating Strict -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowGiphy -Setting to enable giphy for team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GiphyContentRating -Settings to set content rating for giphy. -Can be "Strict" or "Moderate" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowStickersAndMemes -Enable Stickers and memes - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCustomMemes -Allow custom memes to be uploaded - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### GroupId, AllowGiphy, GiphyContentRating, AllowStickersAndMemes, AllowCustomMemes - - -## OUTPUTS - - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamGuestSettings.md b/teams/teams-ps/teams/Set-TeamGuestSettings.md deleted file mode 100644 index 97674abb46..0000000000 --- a/teams/teams-ps/teams/Set-TeamGuestSettings.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamGuestSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teamguestsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamGuestSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Updates team guest settings. - -## SYNTAX - -``` -Set-TeamGuestSettings -GroupId [-AllowCreateUpdateChannels ] [-AllowDeleteChannels ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamGuestSettings -GroupId a61f5a96-a0cf-43db-a7c8-cec05f8a8fc4 -AllowCreateUpdateChannels true -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowCreateUpdateChannels -Settings to create and update channels - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDeleteChannels -Settings to Delete channels - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### GroupId - -### AllowCreateUpdateChannels - -### AllowDeleteChannels - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamMemberSettings.md b/teams/teams-ps/teams/Set-TeamMemberSettings.md deleted file mode 100644 index 0e21dfe1c8..0000000000 --- a/teams/teams-ps/teams/Set-TeamMemberSettings.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamMemberSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teammembersettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamMemberSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Updates team member settings. - -## SYNTAX - -``` -Set-TeamMemberSettings -GroupId [-AllowCreateUpdateChannels ] [-AllowDeleteChannels ] - [-AllowAddRemoveApps ] [-AllowCreateUpdateRemoveTabs ] - [-AllowCreateUpdateRemoveConnectors ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamMemberSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowCreateUpdateChannels false -``` - -### -------------------------- Example 2 -------------------------- -``` -Set-TeamMemberSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowDeleteChannels true -AllowAddRemoveApps false -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowCreateUpdateChannels -Setting to create and update channels - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDeleteChannels -Setting to Delete channels - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAddRemoveApps -Setting to add and remove apps to teams - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCreateUpdateRemoveTabs -Setting to create, update and remove tabs - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCreateUpdateRemoveConnectors -Setting to create, update and remove connectors - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### GroupId - -### AllowCreateUpdateChannels - -### AllowDeleteChannels - -### AllowAddRemoveApps - -### AllowCreateUpdateRemoveTabs - -### AllowCreateUpdateRemoveConnectors - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamMessagingSettings.md b/teams/teams-ps/teams/Set-TeamMessagingSettings.md deleted file mode 100644 index eebbf86afa..0000000000 --- a/teams/teams-ps/teams/Set-TeamMessagingSettings.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -applicable: Microsoft Teams -title: Set-TeamMessagingSettings -online version: https://learn.microsoft.com/powershell/module/teams/set-teammessagingsettings -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Set-TeamMessagingSettings - -## SYNOPSIS -Note: This cmdlet is deprecated as of our 1.0 PowerShell release, and is not supported in our 1.0 release. To set a Team's settings, run Set-Team. - -Updates team messaging settings. - -## SYNTAX - -``` -Set-TeamMessagingSettings -GroupId [-AllowUserEditMessages ] - [-AllowUserDeleteMessages ] [-AllowOwnerDeleteMessages ] [-AllowTeamMentions ] - [-AllowChannelMentions ] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-TeamMessagingSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowUserEditMessages true -``` - -### -------------------------- Example 2 -------------------------- -``` -Set-TeamMessagingSettings -GroupId 4ba546e6-e28d-4645-8cc1-d3575ef9d266 -AllowUserDeleteMessages false -AllowChannelMentions true -``` - -## PARAMETERS - -### -GroupId -GroupId of the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUserEditMessages -Setting to allow user to edit messages - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserDeleteMessages -Setting to allow user to delete messages - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOwnerDeleteMessages -Setting to allow owner to Delete messages - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTeamMentions -Allow @team or @\[team name\] mentions. -This will notify everyone in the team - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowChannelMentions -Allow @channel or @\[channel name\] mentions. -This wil notify members who've favorited that channel - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### GroupId - -### AllowUserEditMessages - -### AllowUserDeleteMessages - -### AllowOwnerDeleteMessages - -### AllowTeamMentions - -### AllowChannelMentions - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/Update-TeamsAppInstallation.md b/teams/teams-ps/teams/Update-TeamsAppInstallation.md deleted file mode 100644 index d7ce547680..0000000000 --- a/teams/teams-ps/teams/Update-TeamsAppInstallation.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/teams/update-teamsappinstallation -title: Update-TeamsAppInstallation -schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: ---- - -# Update-TeamsAppInstallation - -## SYNOPSIS -Update a Teams App in Microsoft Teams. - -## SYNTAX - -### TeamScope -``` -Update-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -TeamId - [-Permissions ] [] -``` - -### UserScope -``` -Update-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -UserId - [-Permissions ] [] -``` - -## DESCRIPTION -Update a Teams App in Microsoft Teams. -This won't update teams client; this will update an application installed on the user/team. - -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Update-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -``` - -This example updates a Teams App in Microsoft Teams specifying its AppId and TeamId. - -### Example 2 -```powershell -PS C:\> Update-TeamsAppInstallation -AppId b9cc7986-dd56-4b57-ab7d-9c4e5288b775 -TeamId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -Permissions "TeamSettings.Read.Group ChannelMessage.Read.Group" -``` - -This example updates a Teams App in Microsoft Teams specifying its AppId and TeamId and RSC Permissions. - -## PARAMETERS - -### -AppId -Teams App identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AppInstallationId -Installation identifier of the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Permissions -RSC permissions for the Teams App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeamId -Team identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: TeamScope -Aliases: GroupId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserId -User identifier in Microsoft Teams. - -```yaml -Type: String -Parameter Sets: UserScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/teams/teams-ps/teams/teams.md b/teams/teams-ps/teams/teams.md deleted file mode 100644 index 058504f325..0000000000 --- a/teams/teams-ps/teams/teams.md +++ /dev/null @@ -1,548 +0,0 @@ ---- -Module Name: Microsoft Teams PowerShell -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -title: teams ---- - -# Microsoft Teams PowerShell - -## Description -The following cmdlet references are for Microsoft Teams. - -## Microsoft Teams Cmdlets - -### [Add-TeamChannelUser](Add-TeamChannelUser.md) -### [Add-TeamsAppInstallation](Add-TeamsAppInstallation.md) -### [Add-TeamUser](Add-TeamUser.md) -### [Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) -### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md) -### [Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) -### [Connect-MicrosoftTeams](Connect-MicrosoftTeams.md) -### [Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) -### [Disable-CsTeamsShiftsConnectionErrorReport](Disable-CsTeamsShiftsConnectionErrorReport.md) -### [Disconnect-MicrosoftTeams](Disconnect-MicrosoftTeams.md) -### [Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) -### [Export-CsAcquiredPhoneNumber](Export-CsAcquiredPhoneNumber.md) -### [Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) -### [export-csonlineaudiofile](export-csonlineaudiofile.md) -### [Find-CsGroup](Find-CsGroup.md) -### [Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) -### [Get-AssociatedTeam](Get-AssociatedTeam.md) -### [Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) -### [Get-CsApplicationMeetingConfiguration](Get-CsApplicationMeetingConfiguration.md) -### [Get-CsAutoAttendant](Get-CsAutoAttendant.md) -### [Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) -### [Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) -### [Get-CsAutoAttendantSupportedLanguage](Get-CsAutoAttendantSupportedLanguage.md) -### [Get-CsAutoAttendantSupportedTimeZone](Get-CsAutoAttendantSupportedTimeZone.md) -### [Get-CsAutoAttendantTenantInformation](Get-CsAutoAttendantTenantInformation.md) -### [Get-CsBatchPolicyAssignmentOperation](Get-CsBatchPolicyAssignmentOperation.md) -### [Get-CsBatchTeamsDeploymentStatus](Get-CsBatchTeamsDeploymentStatus.md) -### [Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) -### [Get-CsCallQueue](Get-CsCallQueue.md) -### [Get-CsCloudCallDataConnection](Get-CsCloudCallDataConnection.md) -### [Get-CsDialPlan](Get-CsDialPlan.md) -### [Get-CsEffectiveTenantDialPlan](Get-CsEffectiveTenantDialPlan.md) -### [Get-CsExportAcquiredPhoneNumberStatus](Get-CsExportAcquiredPhoneNumberStatus.md) -### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) -### [Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) -### [Get-CsHybridTelephoneNumber](Get-CsHybridTelephoneNumber.md) -### [Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) -### [Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) -### [Get-CsMeetingMigrationStatus](Get-CsMeetingMigrationStatus.md) -### [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) -### [Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) -### [Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) -### [Get-CsCsOnlineAudioConferencingRoutingPolicy][Get-CsOnlineAudioConferencingRoutingPolicy.md] -### [Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) -### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) -### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) -### [Get-CsOnlineDialinConferencingTenantConfiguration](Get-CsOnlineDialinConferencingTenantConfiguration.md) -### [Get-CsOnlineDialInConferencingTenantSettings](Get-CsOnlineDialInConferencingTenantSettings.md) -### [Get-CsOnlineDialInConferencingUser](Get-CsOnlineDialInConferencingUser.md) -### [Get-CsOnlineDialOutPolicy](Get-CsOnlineDialOutPolicy.md) -### [Get-CsOnlineDirectoryTenant](Get-CsOnlineDirectoryTenant.md) -### [Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) -### [Get-CsOnlineLisCivicAddress](Get-CsOnlineLisCivicAddress.md) -### [Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) -### [Get-CsOnlineLisPort](Get-CsOnlineLisPort.md) -### [Get-CsOnlineLisSubnet](Get-CsOnlineLisSubnet.md) -### [Get-CsOnlineLisSwitch](Get-CsOnlineLisSwitch.md) -### [Get-CsOnlineLisWirelessAccessPoint](Get-CsOnlineLisWirelessAccessPoint.md) -### [Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) -### [Get-CsOnlinePstnUsage](Get-CsOnlinePstnUsage.md) -### [Get-CsOnlineSchedule](Get-CsOnlineSchedule.md) -### [Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) -### [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) -### [Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) -### [Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) -### [Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) -### [Get-CsOnlineUser](Get-CsOnlineUser.md) -### [Get-CsOnlineVoicemailPolicy](Get-CsOnlineVoicemailPolicy.md) -### [Get-CsOnlineVoicemailUserSettings](Get-CsOnlineVoicemailUserSettings.md) -### [Get-CsOnlineVoiceRoute](Get-CsOnlineVoiceRoute.md) -### [Get-CsOnlineVoiceRoutingPolicy](Get-CsOnlineVoiceRoutingPolicy.md) -### [Get-CsOnlineVoiceUser](Get-CsOnlineVoiceUser.md) -### [Get-CsPhoneNumberAssignment](Get-CsPhoneNumberAssignment.md) -### [Get-CsPolicyPackage](Get-CsPolicyPackage.md) -### [Get-CsTeamsAcsFederationConfiguration](Get-CsTeamsAcsFederationConfiguration.md) -### [Get-CsTeamsAppPermissionPolicy](Get-CsTeamsAppPermissionPolicy.md) -### [Get-CsTeamsAppSetupPolicy](Get-CsTeamsAppSetupPolicy.md) -### [Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) -### [Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) -### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) -### [Get-CsTeamsCallParkPolicy](Get-CsTeamsCallParkPolicy.md) -### [Get-CsTeamsChannelsPolicy](Get-CsTeamsChannelsPolicy.md) -### [Get-CsTeamsClientConfiguration](Get-CsTeamsClientConfiguration.md) -### [Get-CsTeamsComplianceRecordingApplication](Get-CsTeamsComplianceRecordingApplication.md) -### [Get-CsTeamsComplianceRecordingPolicy](Get-CsTeamsComplianceRecordingPolicy.md) -### [Get-CsTeamsCortanaPolicy](Get-CsTeamsCortanaPolicy.md) -### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) -### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) -### [Get-CsTeamsEducationAssignmentsAppPolicy](Get-CsTeamsEducationAssignmentsAppPolicy.md) -### [Get-CsTeamsEducationConfiguration](Get-CsTeamsEducationConfiguration.md) -### [Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) -### [Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) -### [Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) -### [Get-CsTeamsEventsPolicy](Get-CsTeamsEventsPolicy.md) -### [Get-CsTeamsFeedbackPolicy](Get-CsTeamsFeedbackPolicy.md) -### [Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) -### [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) -### [Get-CsTeamsGuestCallingConfiguration](Get-CsTeamsGuestCallingConfiguration.md) -### [Get-CsTeamsGuestMeetingConfiguration](Get-CsTeamsGuestMeetingConfiguration.md) -### [Get-CsTeamsGuestMessagingConfiguration](Get-CsTeamsGuestMessagingConfiguration.md) -### [Get-CsTeamsIPPhonePolicy](Get-CsTeamsIPPhonePolicy.md) -### [Get-CsTeamsMediaLoggingPolicy](Get-CsTeamsMediaLoggingPolicy.md) -### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) -### [Get-CsTeamsMeetingBroadcastConfiguration](Get-CsTeamsMeetingBroadcastConfiguration.md) -### [Get-CsTeamsMeetingBroadcastPolicy](Get-CsTeamsMeetingBroadcastPolicy.md) -### [Get-CsTeamsMeetingConfiguration](Get-CsTeamsMeetingConfiguration.md) -### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) -### [Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) -### [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Get-CsTeamsMessagingConfiguration](Get-CsTeamsMessagingConfiguration.md) -### [Get-CsTeamsMessagingPolicy](Get-CsTeamsMessagingPolicy.md) -### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) -### [Get-CsTeamsNetworkRoamingPolicy](Get-CsTeamsNetworkRoamingPolicy.md) -### [Get-CsTeamsRecordingRollOutPolicy](Get-CsTeamsRecordingRollOutPolicy.md) -### [Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) -### [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) -### [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) -### [Get-CsTeamsShiftsConnectionErrorReport](Get-CsTeamsShiftsConnectionErrorReport.md) -### [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) -### [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md) -### [Get-CsTeamsShiftsConnectionSyncResult](Get-CsTeamsShiftsConnectionSyncResult.md) -### [Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) -### [Get-CsTeamsShiftsConnectionWfmTeam](Get-CsTeamsShiftsConnectionWfmTeam.md) -### [Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) -### [Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) -### [Get-CsTeamsSipDevicesConfiguration](Get-CsTeamsSipDevicesConfiguration.md) -### [Get-CsTeamsSurvivableBranchAppliance](Get-CsTeamsSurvivableBranchAppliance.md) -### [Get-CsTeamsSurvivableBranchAppliancePolicy](Get-CsTeamsSurvivableBranchAppliancePolicy.md) -### [Get-CsTeamsTargetingPolicy](Get-CsTeamsTargetingPolicy.md) -### [Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) -### [Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) -### [Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) -### [Get-CsTeamsUpdateManagementPolicy](Get-CsTeamsUpdateManagementPolicy.md) -### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) -### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) -### [Get-CsTeamsVdiPolicy](Get-CsTeamsVdiPolicy.md) -### [Get-CsTeamsVideoInteropServicePolicy](Get-CsTeamsVideoInteropServicePolicy.md) -### [Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) -### [Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) -### [Get-CsTeamsWorkLoadPolicy](Get-CsTeamsWorkLoadPolicy.md) -### [Get-CsTeamsWorkLocationDetectionPolicy](Get-CsTeamsWorkLocationDetectionPolicy.md) -### [Get-CsTeamTemplate](Get-CsTeamTemplate.md) -### [Get-CsTeamTemplateList](Get-CsTeamTemplateList.md) -### [Get-CsTenant](Get-CsTenant.md) -### [Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) -### [Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) -### [Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) -### [Get-CsTenantLicensingConfiguration](Get-CsTenantLicensingConfiguration.md) -### [Get-CsTenantMigrationConfiguration](Get-CsTenantMigrationConfiguration.md) -### [Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) -### [Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) -### [Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) -### [Get-CsTenantTrustedIPAddress](Get-CsTenantTrustedIPAddress.md) -### [Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) -### [Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md) -### [Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) -### [Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) -### [Get-CsVideoInteropServiceProvider](Get-CsVideoInteropServiceProvider.md) -### [Get-LicenseReportForChangeNotificationSubscription](Get-LicenseReportForChangeNotificationSubscription.md) -### [Get-M365UnifiedCustomPendingApps](Get-M365UnifiedCustomPendingApps.md) -### [Get-SharedWithTeam](Get-SharedWithTeam.md) -### [Get-SharedWithTeamUser](Get-SharedWithTeamUser.md) -### [Get-Team](Get-Team.md) -### [Get-TeamAllChannel](Get-TeamAllChannel.md) -### [Get-TeamChannel](Get-TeamChannel.md) -### [Get-TeamChannelUser](Get-TeamChannelUser.md) -### [Get-TeamFunSettings](Get-TeamFunSettings.md) -### [Get-TeamGuestSettings](Get-TeamGuestSettings.md) -### [Get-TeamIncomingChannel](Get-TeamIncomingChannel.md) -### [Get-TeamMemberSettings](Get-TeamMemberSettings.md) -### [Get-TeamMessagingSettings](Get-TeamMessagingSettings.md) -### [Get-TeamsApp](Get-TeamsApp.md) -### [Get-TeamsAppInstallation](Get-TeamsAppInstallation.md) -### [Get-TeamTargetingHierarchyStatus](Get-TeamTargetingHierarchyStatus.md) -### [Get-TeamUser](Get-TeamUser.md) -### [Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) -### [Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) -### [Grant-CsCloudMeetingPolicy](Grant-CsCloudMeetingPolicy.md) -### [Grant-CsDialoutPolicy](Grant-CsDialoutPolicy.md) -### [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) -### [Grant-CsExternalUserCommunicationPolicy](Grant-CsExternalUserCommunicationPolicy.md) -### [Grant-CsGroupPolicyPackageAssignment](Grant-CsGroupPolicyPackageAssignment.md) -### [Grant-CsOnlineVoicemailPolicy](Grant-CsOnlineVoicemailPolicy.md) -### [Grant-CsOnlineVoiceRoutingPolicy](Grant-CsOnlineVoiceRoutingPolicy.md) -### [Grant-CsTeamsAppPermissionPolicy](Grant-CsTeamsAppPermissionPolicy.md) -### [Grant-CsTeamsAppSetupPolicy](Grant-CsTeamsAppSetupPolicy.md) -### [Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) -### [Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) -### [Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) -### [Grant-CsTeamsCallParkPolicy](Grant-CsTeamsCallParkPolicy.md) -### [Grant-CsTeamsChannelsPolicy](Grant-CsTeamsChannelsPolicy.md) -### [Grant-CsTeamsComplianceRecordingPolicy](Grant-CsTeamsComplianceRecordingPolicy.md) -### [Grant-CsTeamsCortanaPolicy](Grant-CsTeamsCortanaPolicy.md) -### [Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) -### [Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) -### [Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) -### [Grant-CsTeamsEventsPolicy](Grant-CsTeamsEventsPolicy.md) -### [Grant-CsTeamsFeedbackPolicy](Grant-CsTeamsFeedbackPolicy.md) -### [Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) -### [Grant-CsTeamsIPPhonePolicy](Grant-CsTeamsIPPhonePolicy.md) -### [Grant-CsTeamsMediaLoggingPolicy](Grant-CsTeamsMediaLoggingPolicy.md) -### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) -### [Grant-CsTeamsMeetingBroadcastPolicy](Grant-CsTeamsMeetingBroadcastPolicy.md) -### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) -### [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Grant-CsTeamsMessagingPolicy](Grant-CsTeamsMessagingPolicy.md) -### [Grant-CsTeamsMobilityPolicy](Grant-CsTeamsMobilityPolicy.md) -### [Grant-CsTeamsRecordingRollOutPolicy](Grant-CsTeamsRecordingRollOutPolicy.md) -### [Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) -### [Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) -### [Grant-CsTeamsUpdateManagementPolicy](Grant-CsTeamsUpdateManagementPolicy.md) -### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -### [Grant-CsTeamsVdiPolicy](Grant-CsTeamsVdiPolicy.md) -### [Grant-CsTeamsVideoInteropServicePolicy](Grant-CsTeamsVideoInteropServicePolicy.md) -### [Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) -### [Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) -### [Grant-CsTeamsWorkLoadPolicy](Grant-CsTeamsWorkLoadPolicy.md) -### [Grant-CsTeamsWorkLocationDetectionPolicy](Grant-CsTeamsWorkLocationDetectionPolicy.md) -### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) -### [Grant-CsUserPolicyPackage](Grant-CsUserPolicyPackage.md) -### [Import-CsAutoAttendantHolidays](Import-CsAutoAttendantHolidays.md) -### [Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) -### [New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) -### [New-CsAutoAttendant](New-CsAutoAttendant.md) -### [New-CsAutoAttendantCallableEntity](New-CsAutoAttendantCallableEntity.md) -### [New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) -### [New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md) -### [New-CsAutoAttendantDialScope](New-CsAutoAttendantDialScope.md) -### [New-CsAutoAttendantMenu](New-CsAutoAttendantMenu.md) -### [New-CsAutoAttendantMenuOption](New-CsAutoAttendantMenuOption.md) -### [New-CsAutoAttendantPrompt](New-CsAutoAttendantPrompt.md) -### [New-CsBatchPolicyAssignmentOperation](New-CsBatchPolicyAssignmentOperation.md) -### [New-CsBatchPolicyPackageAssignmentOperation](New-CsBatchPolicyPackageAssignmentOperation.md) -### [New-CsBatchTeamsDeployment](New-CsBatchTeamsDeployment.md) -### [New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) -### [New-CsCallQueue](New-CsCallQueue.md) -### [New-CsCloudCallDataConnection](New-CsCloudCallDataConnection.md) -### [New-CsCustomPolicyPackage](New-CsCustomPolicyPackage.md) -### [New-CsEdgeAllowAllKnownDomains](New-CsEdgeAllowAllKnownDomains.md) -### [New-CsEdgeAllowList](New-CsEdgeAllowList.md) -### [New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) -### [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) -### [New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md) -### [New-CsHybridTelephoneNumber](New-CsHybridTelephoneNumber.md) -### [New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) -### [New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) -### [New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) -### [New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) -### [New-CsCsOnlineAudioConferencingRoutingPolicy][New-CsOnlineAudioConferencingRoutingPolicy.md] -### [New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) -### [New-CsOnlineLisCivicAddress](New-CsOnlineLisCivicAddress.md) -### [New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) -### [New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) -### [New-CsOnlineSchedule](New-CsOnlineSchedule.md) -### [New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) -### [New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) -### [New-CsOnlineVoicemailPolicy](New-CsOnlineVoicemailPolicy.md) -### [New-CsOnlineVoiceRoute](New-CsOnlineVoiceRoute.md) -### [New-CsOnlineVoiceRoutingPolicy](New-CsOnlineVoiceRoutingPolicy.md) -### [New-CsTeamsAppPermissionPolicy](New-CsTeamsAppPermissionPolicy.md) -### [New-CsTeamsAppSetupPolicy](New-CsTeamsAppSetupPolicy.md) -### [New-CsTeamsAudioConferencingPolicy](New-CsTeamsAudioConferencingPolicy.md) -### [New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) -### [New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) -### [New-CsTeamsCallParkPolicy](New-CsTeamsCallParkPolicy.md) -### [New-CsTeamsChannelsPolicy](New-CsTeamsChannelsPolicy.md) -### [New-CsTeamsComplianceRecordingApplication](New-CsTeamsComplianceRecordingApplication.md) -### [New-CsTeamsComplianceRecordingPairedApplication](New-CsTeamsComplianceRecordingPairedApplication.md) -### [New-CsTeamsComplianceRecordingPolicy](New-CsTeamsComplianceRecordingPolicy.md) -### [New-CsTeamsCortanaPolicy](New-CsTeamsCortanaPolicy.md) -### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) -### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) -### [New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) -### [New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) -### [New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) -### [New-CsTeamsEmergencyNumber](New-CsTeamsEmergencyNumber.md) -### [New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) -### [New-CsTeamsEventsPolicy](New-CsTeamsEventsPolicy.md) -### [New-CsTeamsFeedbackPolicy](New-CsTeamsFeedbackPolicy.md) -### [New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) -### [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md) -### [New-CsTeamsHiddenTemplate](New-CsTeamsHiddenTemplate.md) -### [New-CsTeamsIPPhonePolicy](New-CsTeamsIPPhonePolicy.md) -### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) -### [New-CsTeamsMeetingBroadcastPolicy](New-CsTeamsMeetingBroadcastPolicy.md) -### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) -### [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) -### [New-CsTeamsMessagingPolicy](New-CsTeamsMessagingPolicy.md) -### [New-CsTeamsMobilityPolicy](New-CsTeamsMobilityPolicy.md) -### [New-CsTeamsNetworkRoamingPolicy](New-CsTeamsNetworkRoamingPolicy.md) -### [New-CsTeamsPinnedApp](New-CsTeamsPinnedApp.md) -### [New-CsTeamsRecordingRollOutPolicy](New-CsTeamsRecordingRollOutPolicy.md) -### [New-CsTeamsSharedCallingRoutingPolicy](New-CsTeamsSharedCallingRoutingPolicy.md) -### [New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) -### [New-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.md) -### [New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) -### [New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) -### [New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) -### [New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) -### [New-CsTeamsUnassignedNumberTreatment](New-CsTeamsUnassignedNumberTreatment.md) -### [New-CsTeamsUpdateManagementPolicy](New-CsTeamsUpdateManagementPolicy.md) -### [New-CsTeamsVdiPolicy](New-CsTeamsVdiPolicy.md) -### [New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) -### [New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) -### [New-CsTeamsWorkLoadPolicy](New-CsTeamsWorkLoadPolicy.md) -### [New-CsTeamsWorkLocationDetectionPolicy](New-CsTeamsWorkLocationDetectionPolicy.md) -### [New-CsTeamTemplate](New-CsTeamTemplate.md) -### [New-CsTenantDialPlan](New-CsTenantDialPlan.md) -### [New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) -### [New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) -### [New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) -### [New-CsTenantTrustedIPAddress](New-CsTenantTrustedIPAddress.md) -### [New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) -### [New-CsVideoInteropServiceProvider](New-CsVideoInteropServiceProvider.md) -### [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) -### [New-Team](New-Team.md) -### [New-TeamChannel](New-TeamChannel.md) -### [New-TeamsApp](New-TeamsApp.md) -### [Register-CsOnlineDialInConferencingServiceNumber](Register-CsOnlineDialInConferencingServiceNumber.md) -### [Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) -### [Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) -### [Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) -### [Remove-CsCallQueue](Remove-CsCallQueue.md) -### [Remove-CsCustomPolicyPackage](Remove-CsCustomPolicyPackage.md) -### [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) -### [Remove-CsGroupPolicyAssignment](Remove-CsGroupPolicyAssignment.md) -### [Remove-CsHybridTelephoneNumber](Remove-CsHybridTelephoneNumber.md) -### [Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) -### [Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) -### [Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) -### [Remove-CsCsOnlineAudioConferencingRoutingPolicy][Remove-CsOnlineAudioConferencingRoutingPolicy.md] -### [Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) -### [Remove-CsOnlineDialInConferencingTenantSettings](Remove-CsOnlineDialInConferencingTenantSettings.md) -### [Remove-CsOnlineLisCivicAddress](Remove-CsOnlineLisCivicAddress.md) -### [Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) -### [Remove-CsOnlineLisPort](Remove-CsOnlineLisPort.md) -### [Remove-CsOnlineLisSubnet](Remove-CsOnlineLisSubnet.md) -### [Remove-CsOnlineLisSwitch](Remove-CsOnlineLisSwitch.md) -### [Remove-CsOnlineLisWirelessAccessPoint](Remove-CsOnlineLisWirelessAccessPoint.md) -### [Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) -### [Remove-CsOnlineSchedule](Remove-CsOnlineSchedule.md) -### [Remove-CsOnlineTelephoneNumber](Remove-CsOnlineTelephoneNumber.md) -### [Remove-CsOnlineVoicemailPolicy](Remove-CsOnlineVoicemailPolicy.md) -### [Remove-CsOnlineVoiceRoute](Remove-CsOnlineVoiceRoute.md) -### [Remove-CsOnlineVoiceRoutingPolicy](Remove-CsOnlineVoiceRoutingPolicy.md) -### [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) -### [Remove-CsTeamsAppPermissionPolicy](Remove-CsTeamsAppPermissionPolicy.md) -### [Remove-CsTeamsAppSetupPolicy](Remove-CsTeamsAppSetupPolicy.md) -### [Remove-CsTeamsAudioConferencingPolicy](Remove-CsTeamsAudioConferencingPolicy.md) -### [Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) -### [Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) -### [Remove-CsTeamsCallParkPolicy](Remove-CsTeamsCallParkPolicy.md) -### [Remove-CsTeamsChannelsPolicy](Remove-CsTeamsChannelsPolicy.md) -### [Remove-CsTeamsComplianceRecordingApplication](Remove-CsTeamsComplianceRecordingApplication.md) -### [Remove-CsTeamsComplianceRecordingPolicy](Remove-CsTeamsComplianceRecordingPolicy.md) -### [Remove-CsTeamsCortanaPolicy](Remove-CsTeamsCortanaPolicy.md) -### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) -### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) -### [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) -### [Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) -### [Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) -### [Remove-CsTeamsEventsPolicy](Remove-CsTeamsEventsPolicy.md) -### [Remove-CsTeamsFeedbackPolicy](Remove-CsTeamsFeedbackPolicy.md) -### [Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) -### [Remove-CsTeamsIPPhonePolicy](Remove-CsTeamsIPPhonePolicy.md) -### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) -### [Remove-CsTeamsMeetingBroadcastPolicy](Remove-CsTeamsMeetingBroadcastPolicy.md) -### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) -### [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Remove-CsTeamsMessagingPolicy](Remove-CsTeamsMessagingPolicy.md) -### [Remove-CsTeamsMobilityPolicy](Remove-CsTeamsMobilityPolicy.md) -### [Remove-CsTeamsNetworkRoamingPolicy](Remove-CsTeamsNetworkRoamingPolicy.md) -### [Remove-CsTeamsPinnedApp](Remove-CsTeamsPinnedApp.md) -### [Remove-CsTeamsRecordingRollOutPolicy](Remove-CsTeamsRecordingRollOutPolicy.md) -### [Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) -### [Remove-CsTeamsShiftsConnection](Remove-CsTeamsShiftsConnection.md) -### [Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) -### [Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) -### [Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) -### [Remove-CsTeamsShiftsScheduleRecord](Remove-CsTeamsShiftsScheduleRecord.md) -### [Remove-CsTeamsSurvivableBranchAppliance](Remove-CsTeamsSurvivableBranchAppliance.md) -### [Remove-CsTeamsSurvivableBranchAppliancePolicy](Remove-CsTeamsSurvivableBranchAppliancePolicy.md) -### [Remove-CsTeamsTargetingPolicy](Remove-CsTeamsTargetingPolicy.md) -### [Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) -### [Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) -### [Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) -### [Remove-CsTeamsUpdateManagementPolicy](Remove-CsTeamsUpdateManagementPolicy.md) -### [Remove-CsTeamsVdiPolicy](Remove-CsTeamsVdiPolicy.md) -### [Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) -### [Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) -### [Remove-CsTeamsWorkLoadPolicy](Remove-CsTeamsWorkLoadPolicy.md) -### [Remove-CsTeamsWorkLocationDetectionPolicy](Remove-CsTeamsWorkLocationDetectionPolicy.md) -### [Remove-CsTeamTemplate](Remove-CsTeamTemplate.md) -### [Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) -### [Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) -### [Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) -### [Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) -### [Remove-CsTenantTrustedIPAddress](Remove-CsTenantTrustedIPAddress.md) -### [Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) -### [Remove-CsVideoInteropServiceProvider](Remove-CsVideoInteropServiceProvider.md) -### [Remove-SharedWithTeam](Remove-SharedWithTeam.md) -### [Remove-Team](Remove-Team.md) -### [Remove-TeamChannel](Remove-TeamChannel.md) -### [Remove-TeamChannelUser](Remove-TeamChannelUser.md) -### [Remove-TeamsApp](Remove-TeamsApp.md) -### [Remove-TeamsAppInstallation](Remove-TeamsAppInstallation.md) -### [Remove-TeamTargetingHierarchy](Remove-TeamTargetingHierarchy.md) -### [Remove-TeamUser](Remove-TeamUser.md) -### [Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) -### [Set-CsApplicationMeetingConfiguration](Set-CsApplicationMeetingConfiguration.md) -### [Set-CsAutoAttendant](Set-CsAutoAttendant.md) -### [Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) -### [Set-CsCallQueue](Set-CsCallQueue.md) -### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) -### [Set-CsGroupPolicyAssignment](Set-CsGroupPolicyAssignment.md) -### [Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) -### [Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) -### [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) -### [Set-CsCsOnlineAudioConferencingRoutingPolicy][Set-CsOnlineAudioConferencingRoutingPolicy.md] -### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) -### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) -### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md) -### [Set-CsOnlineDialInConferencingUser](Set-CsOnlineDialInConferencingUser.md) -### [Set-CsOnlineEnhancedEmergencyServiceDisclaimer](Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md) -### [Set-CsOnlineLisCivicAddress](Set-CsOnlineLisCivicAddress.md) -### [Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) -### [Set-CsOnlineLisPort](Set-CsOnlineLisPort.md) -### [Set-CsOnlineLisSubnet](Set-CsOnlineLisSubnet.md) -### [Set-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) -### [Set-CsOnlineLisWirelessAccessPoint](Set-CsOnlineLisWirelessAccessPoint.md) -### [Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) -### [Set-CsOnlinePstnUsage](Set-CsOnlinePstnUsage.md) -### [Set-CsOnlineSchedule](Set-CsOnlineSchedule.md) -### [Set-CsOnlineVoiceApplicationInstance](Set-CsOnlineVoiceApplicationInstance.md) -### [Set-CsOnlineVoicemailPolicy](Set-CsOnlineVoicemailPolicy.md) -### [Set-CsOnlineVoicemailUserSettings](Set-CsOnlineVoicemailUserSettings.md) -### [Set-CsOnlineVoiceRoute](Set-CsOnlineVoiceRoute.md) -### [Set-CsOnlineVoiceRoutingPolicy](Set-CsOnlineVoiceRoutingPolicy.md) -### [Set-CsOnlineVoiceUser](Set-CsOnlineVoiceUser.md) -### [Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) -### [Set-CsTeamsAcsFederationConfiguration](Set-CsTeamsAcsFederationConfiguration.md) -### [Set-CsTeamsAppPermissionPolicy](Set-CsTeamsAppPermissionPolicy.md) -### [Set-CsTeamsAppSetupPolicy](Set-CsTeamsAppSetupPolicy.md) -### [Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) -### [Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) -### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) -### [Set-CsTeamsCallParkPolicy](Set-CsTeamsCallParkPolicy.md) -### [Set-CsTeamsChannelsPolicy](Set-CsTeamsChannelsPolicy.md) -### [Set-CsTeamsClientConfiguration](Set-CsTeamsClientConfiguration.md) -### [Set-CsTeamsComplianceRecordingApplication](Set-CsTeamsComplianceRecordingApplication.md) -### [Set-CsTeamsComplianceRecordingPolicy](Set-CsTeamsComplianceRecordingPolicy.md) -### [Set-CsTeamsCortanaPolicy](Set-CsTeamsCortanaPolicy.md) -### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) -### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) -### [Set-CsTeamsEducationAssignmentsAppPolicy](Set-CsTeamsEducationAssignmentsAppPolicy.md) -### [Set-CsTeamsEducationConfiguration](Set-CsTeamsEducationConfiguration.md) -### [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) -### [Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) -### [Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) -### [Set-CsTeamsEventsPolicy](Set-CsTeamsEventsPolicy.md) -### [Set-CsTeamsFeedbackPolicy](Set-CsTeamsFeedbackPolicy.md) -### [Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) -### [Set-CsTeamsGuestCallingConfiguration](Set-CsTeamsGuestCallingConfiguration.md) -### [Set-CsTeamsGuestMeetingConfiguration](Set-CsTeamsGuestMeetingConfiguration.md) -### [Set-CsTeamsGuestMessagingConfiguration](Set-CsTeamsGuestMessagingConfiguration.md) -### [Set-CsTeamsIPPhonePolicy](Set-CsTeamsIPPhonePolicy.md) -### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) -### [Set-CsTeamsMeetingBroadcastConfiguration](Set-CsTeamsMeetingBroadcastConfiguration.md) -### [Set-CsTeamsMeetingBroadcastPolicy](Set-CsTeamsMeetingBroadcastPolicy.md) -### [Set-CsTeamsMeetingConfiguration](Set-CsTeamsMeetingConfiguration.md) -### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) -### [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) -### [Set-CsTeamsMessagingConfiguration](Set-CsTeamsMessagingConfiguration.md) -### [Set-CsTeamsMessagingPolicy](Set-CsTeamsMessagingPolicy.md) -### [Set-CsTeamsMobilityPolicy](Set-CsTeamsMobilityPolicy.md) -### [Set-CsTeamsNetworkRoamingPolicy](Set-CsTeamsNetworkRoamingPolicy.md) -### [Set-CsTeamsPinnedApp](Set-CsTeamsPinnedApp.md) -### [Set-CsTeamsRecordingRollOutPolicy](Set-CsTeamsRecordingRollOutPolicy.md) -### [Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) -### [Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) -### [Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) -### [Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) -### [Set-CsTeamsSipDevicesConfiguration](Set-CsTeamsSipDevicesConfiguration.md) -### [Set-CsTeamsSurvivableBranchAppliance](Set-CsTeamsSurvivableBranchAppliance.md) -### [Set-CsTeamsSurvivableBranchAppliancePolicy](Set-CsTeamsSurvivableBranchAppliancePolicy.md) -### [Set-CsTeamsTargetingPolicy](Set-CsTeamsTargetingPolicy.md) -### [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) -### [Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) -### [Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) -### [Set-CsTeamsUpdateManagementPolicy](Set-CsTeamsUpdateManagementPolicy.md) -### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) -### [Set-CsTeamsVdiPolicy](Set-CsTeamsVdiPolicy.md) -### [Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) -### [Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) -### [Set-CsTeamsWorkLoadPolicy](Set-CsTeamsWorkLoadPolicy.md) -### [Set-CsTeamsWorkLocationDetectionPolicy](Set-CsTeamsWorkLocationDetectionPolicy.md) -### [Set-CsTenantBlockedCallingNumbers](Set-CsTenantBlockedCallingNumbers.md) -### [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) -### [Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) -### [Set-CsTenantMigrationConfiguration](Set-CsTenantMigrationConfiguration.md) -### [Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) -### [Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) -### [Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) -### [Set-CsTenantTrustedIPAddress](Set-CsTenantTrustedIPAddress.md) -### [Set-CsUser](Set-CsUser.md) -### [Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) -### [Set-CsUserCallingSettings](Set-CsUserCallingSettings.md) -### [Set-CsVideoInteropServiceProvider](Set-CsVideoInteropServiceProvider.md) -### [Set-Team](Set-Team.md) -### [Set-TeamArchivedState](Set-TeamArchivedState.md) -### [Set-TeamChannel](Set-TeamChannel.md) -### [Set-TeamFunSettings](Set-TeamFunSettings.md) -### [Set-TeamGuestSettings](Set-TeamGuestSettings.md) -### [Set-TeamMemberSettings](Set-TeamMemberSettings.md) -### [Set-TeamMessagingSettings](Set-TeamMessagingSettings.md) -### [Set-TeamPicture](Set-TeamPicture.md) -### [Set-TeamsApp](Set-TeamsApp.md) -### [Set-TeamsEnvironmentConfig](Set-TeamsEnvironmentConfig.md) -### [Set-TeamTargetingHierarchy](Set-TeamTargetingHierarchy.md) -### [Start-CsExMeetingMigration](Start-CsExMeetingMigration.md) -### [Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) -### [Test-CsEffectiveTenantDialPlan](Test-CsEffectiveTenantDialPlan.md) -### [Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) -### [Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) -### [Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) -### [Test-CsTeamsUnassignedNumberTreatment](Test-CsTeamsUnassignedNumberTreatment.md) -### [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) -### [Unregister-CsOnlineDialInConferencingServiceNumber](Unregister-CsOnlineDialInConferencingServiceNumber.md) -### [Update-CsAutoAttendant](Update-CsAutoAttendant.md) -### [Update-CsCustomPolicyPackage](Update-CsCustomPolicyPackage.md) -### [Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) -### [Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) -### [Update-CsTeamTemplate](Update-CsTeamTemplate.md) -### [Update-M365UnifiedCustomPendingApp](Update-M365UnifiedCustomPendingApp.md) -### [Update-TeamsAppInstallation](Update-TeamsAppInstallation.md)