Skip to content

Commit 670a9e1

Browse files
Merge pull request #263105 from AikoBB/aigerimb/acs-identity/bot-identifier-ga
[ACS][Common SDK] Microsoft Teams Application Identifier GA
2 parents 25f479a + 31acb9f commit 670a9e1

File tree

9 files changed

+86
-64
lines changed

9 files changed

+86
-64
lines changed

articles/communication-services/concepts/includes/identifiers/identifiers-android.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,14 @@ PhoneNumberIdentifier phoneNumber = new PhoneNumberIdentifier("+112345556789");
7171

7272
[PhoneNumberIdentifier](https://azure.github.io/azure-sdk-for-android/azure-communication-common/com/azure/android/communication/common/PhoneNumberIdentifier.html)
7373

74-
### Microsoft bot
74+
### Microsoft Teams Application
7575

76-
> [!NOTE]
77-
> The Microsoft Bot Identifier is currently in public preview. For more information about previews, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
78-
79-
The `MicrosoftBotIdentifier` interface represents a Microsoft bot with its Microsoft Entra bot object ID. In the preview version the interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant, and the application should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
76+
The `MicrosoftTeamsAppIdentifier` interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant with its Microsoft Entra bot object ID. The Teams applications should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
8077

8178
#### Basic usage
8279

8380
```java
84-
// Get the Microsoft bot's ID from Graph APIs
81+
// Get the Microsoft Teams App's ID from Graph APIs
8582
UserCollectionPage users = graphClient.users()
8683
.buildRequest()
8784
.filter(filterConditions)
@@ -92,16 +89,15 @@ UserCollectionPage users = graphClient.users()
9289
User bot = getBotFromUsers(users);
9390

9491
// Create an identifier
95-
MicrosoftBotIdentifier botIdentifier = new MicrosoftBotIdentifier(bot.id);
92+
MicrosoftTeamsAppIdentifier teamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id);
9693

9794
// If you're not operating in the public cloud, you must also pass the right Cloud type.
98-
// If you use Azure Bot Framework instead of Teams Voice applications, set property isResourceAccountConfigured to false.
99-
MicrosoftBotIdentifier gcchBotIdentifier = new MicrosoftBotIdentifier(bot.id, true, CommunicationCloudEnvironment.GCCH);
95+
MicrosoftTeamsAppIdentifier gcchTeamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id, CommunicationCloudEnvironment.GCCH);
10096
```
10197

10298
#### API reference
10399

104-
[MicrosoftBotIdentifier](https://azure.github.io/azure-sdk-for-android/azure-communication-common/com/azure/android/communication/common/MicrosoftBotIdentifier.html)
100+
[MicrosoftTeamsAppIdentifier](https://azure.github.io/azure-sdk-for-android/azure-communication-common/com/azure/android/communication/common/MicrosoftTeamsAppIdentifier.html)
105101

106102
### Unknown
107103

articles/communication-services/concepts/includes/identifiers/identifiers-ios.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,29 +67,25 @@ let phoneNumber = PhoneNumberIdentifier(phoneNumber: "+112345556789")
6767

6868
[PhoneNumberIdentifier](https://azure.github.io/azure-sdk-for-ios/AzureCommunicationCommon/Classes/PhoneNumberIdentifier.html)
6969

70-
### Microsoft bot
70+
### Microsoft Teams Application
7171

72-
> [!NOTE]
73-
> The Microsoft Bot Identifier is currently in public preview. For more information about previews, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
74-
75-
The `MicrosoftBotIdentifier` interface represents a Microsoft bot with its Microsoft Entra bot object ID. In the preview version the interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant, and the application should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
72+
The `MicrosoftTeamsAppIdentifier` interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant with its Microsoft Entra bot object ID. The Teams applications should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
7673
#### Basic usage
7774

7875
```swift
79-
// Get the Microsoft bot's ID from Graph APIs, assuming a helper method for the Graph API
76+
// Get the Microsoft Teams App's ID from Graph APIs, assuming a helper method for the Graph API
8077
let botId = await getBotIdFromGraph()
8178

8279
// Create an identifier
83-
let botIdentifier = MicrosoftBotIdentifier(botId: botId)
80+
let teamsAppIdentifier = MicrosoftTeamsAppIdentifier(appId: botId)
8481

8582
// If you're not operating in the public cloud, you must also pass the right Cloud type.
86-
// If you use Azure Bot Framework instead of Teams Voice applications, set property isResourceAccountConfigured to false.
87-
let gcchBotIdentifier = MicrosoftBotIdentifier(botId: botId, isResourceAccountConfigured: true, cloudEnvironment: CommunicationCloudEnvironment.Gcch)
83+
let gcchTeamsAppIdentifier = MicrosoftTeamsAppIdentifier(appId: botId, cloudEnvironment: CommunicationCloudEnvironment.Gcch)
8884
```
8985

9086
#### API reference
9187

92-
[MicrosoftBotIdentifier](https://azure.github.io/azure-sdk-for-ios/AzureCommunicationCommon/Classes/MicrosoftBotIdentifier.html)
88+
[MicrosoftTeamsAppIdentifier](https://azure.github.io/azure-sdk-for-ios/AzureCommunicationCommon/Classes/MicrosoftTeamsAppIdentifier.html)
9389

9490
### Unknown
9591

articles/communication-services/concepts/includes/identifiers/identifiers-java.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,14 @@ var phoneNumber = new PhoneNumberIdentifier("+112345556789");
7171

7272
[PhoneNumberIdentifier](/java/api/com.azure.communication.common.phonenumberidentifier)
7373

74-
### Microsoft bot
74+
### Microsoft Teams Application
7575

76-
> [!NOTE]
77-
> The Microsoft Bot Identifier is currently in public preview. For more information about previews, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
78-
79-
The `MicrosoftBotIdentifier` interface represents a Microsoft bot with its Microsoft Entra bot object ID. In the preview version the interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant, and the application should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
76+
The `MicrosoftTeamsAppIdentifier` interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant with its Microsoft Entra bot object ID. The Teams applications should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
8077

8178
#### Basic usage
8279

8380
```java
84-
// Get the Microsoft bot's ID from Graph APIs
81+
// Get the Microsoft Teams App's ID from Graph APIs
8582
var user = graphClient.users()
8683
.buildRequest()
8784
.filter(filterConditions)
@@ -92,16 +89,15 @@ var user = graphClient.users()
9289
var bot = getBotFromUsers(users);
9390

9491
// Create an identifier
95-
var botIdentifier = new MicrosoftBotIdentifier(bot.id);
92+
var teamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id);
9693

9794
// If you're not operating in the public cloud, you must also pass the right Cloud type.
98-
// If you use Azure Bot Framework instead of Teams Voice applications, set property isResourceAccountConfigured to false.
99-
var gcchBotIdentifier = new MicrosoftBotIdentifier(bot.id, true, CommunicationCloudEnvironment.GCCH);
95+
var gcchTeamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id, CommunicationCloudEnvironment.GCCH);
10096
```
10197

10298
#### API reference
10399

104-
[MicrosoftBotIdentifier](/java/api/com.azure.communication.common.microsoftbotidentifier?view=azure-java-preview&preserve-view=true)
100+
[MicrosoftTeamsAppIdentifier](/java/api/com.azure.communication.common.microsoftteamsappidentifier)
105101

106102
### Unknown
107103

articles/communication-services/concepts/includes/identifiers/identifiers-js.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,34 +69,30 @@ const phoneNumber = { phoneNumber: "+112345556789" };
6969

7070
[PhoneNumberIdentifier](/javascript/api/@azure/communication-common/phonenumberidentifier)
7171

72-
### Microsoft bot
72+
### Microsoft Teams Application
7373

74-
> [!NOTE]
75-
> The Microsoft Bot Identifier is currently in public preview. For more information about previews, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
76-
77-
The `MicrosoftTeamsAppIdentifier` interface represents a Microsoft bot with its Microsoft Entra bot object ID. In the preview version the interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant, and the application should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
74+
The `MicrosoftTeamsAppIdentifier` interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant with its Microsoft Entra bot object ID. The Teams applications should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
7875

7976
#### Basic usage
8077

8178
```javascript
82-
// Get the Microsoft bot's ID from Graph APIs
79+
// Get the Microsoft Teams App's ID from Graph APIs
8380
const users = await graphClient.api("/users")
8481
.filter(filterConditions)
8582
.select('displayName,id')
8683
.get();
8784
//Here we assume that you have a function getBotFromUsers that gets the bot from the returned response
8885
const bot = getBotFromUsers(users);
8986
// Create an identifier
90-
const botIdentifier = { teamsAppId: bot.id };
87+
const teamsAppIdentifier = { teamsAppId: bot.id };
9188

9289
// If you're not operating in the public cloud, you must also pass the right Cloud type.
93-
// If you use Azure Bot Framework instead of Teams Voice applications, set property isResourceAccountConfigured to false.
94-
const gcchBotIdentifier = { teamsAppId: id, cloud: "gcch" };
90+
const gcchTeamsAppIdentifier = { teamsAppId: id, cloud: "gcch" };
9591
```
9692

9793
#### API reference
9894

99-
[MicrosoftBotIdentifier](/javascript/api/@azure/communication-common/microsoftbotidentifier?view=azure-node-preview&preserve-view=true)
95+
[MicrosoftTeamsAppIdentifier](/javascript/api/@azure/communication-common/microsoftteamsappidentifier)
10096

10197
### Unknown
10298

articles/communication-services/concepts/includes/identifiers/identifiers-net.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,14 @@ var phoneNumber = new PhoneNumberIdentifier("+112345556789");
7171

7272
[PhoneNumberIdentifier](/dotnet/api/azure.communication.phonenumberidentifier)
7373

74-
### Microsoft bot
74+
### Microsoft Teams Application
7575

76-
> [!NOTE]
77-
> The Microsoft Bot Identifier is currently in public preview. For more information about previews, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
78-
79-
The `MicrosoftBotIdentifier` interface represents a Microsoft bot with its Microsoft Entra bot object ID. In the preview version the interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant, and the application should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
76+
The `MicrosoftTeamsAppIdentifier` interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant with its Microsoft Entra bot object ID. The Teams applications should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
8077

8178
#### Basic usage
8279

8380
```csharp
84-
// Get the Microsoft bot's ID from Graph APIs
81+
// Get the Microsoft Teams App's ID from Graph APIs
8582
var users = await graphClient.Users.GetAsync((requestConfiguration) =>
8683
{
8784
requestConfiguration.QueryParameters.Select = new string []{ "displayName","id" };
@@ -92,16 +89,15 @@ var users = await graphClient.Users.GetAsync((requestConfiguration) =>
9289
var bot = GetBotFromUsers(users);
9390

9491
// Create an identifier
95-
var botIdentifier = new MicrosoftBotIdentifier(bot.Id);
92+
var teamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.Id);
9693

9794
// If you're not operating in the public cloud, you must also pass the right Cloud type.
98-
// If you use Azure Bot Framework instead of Teams Voice applications, set property isResourceAccountConfigured to false.
99-
var gcchBotIdentifier = new MicrosoftBotIdentifier(bot.Id, true, CommunicationCloudEnvironment.Gcch);
95+
var gcchTeamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.Id, CommunicationCloudEnvironment.Gcch);
10096
```
10197

10298
#### API reference
10399

104-
[MicrosoftBotIdentifier](/dotnet/api/azure.communication.microsoftbotidentifier?view=azure-dotnet-preview&preserve-view=true)
100+
[MicrosoftTeamsAppIdentifier](/dotnet/api/azure.communication.microsoftteamsappidentifier)
105101

106102
### Unknown
107103

articles/communication-services/concepts/includes/identifiers/identifiers-python.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -69,37 +69,32 @@ phone_number = PhoneNumberIdentifier("+112345556789")
6969

7070
[PhoneNumberIdentifier](/python/api/azure-communication-chat/azure.communication.chat.phonenumberidentifier)
7171

72-
### Microsoft bot
72+
### Microsoft Teams Application
7373

74-
> [!NOTE]
75-
> The Microsoft Bot Identifier is currently in public preview. For more information about previews, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
76-
77-
The `MicrosoftBotIdentifier` interface represents a Microsoft bot with its Microsoft Entra bot object ID. In the preview version the interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant, and the application should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
74+
The `MicrosoftTeamsAppIdentifier` interface represents a bot of the Teams Voice applications such as Call Queue and Auto Attendant with its Microsoft Entra bot object ID. The Teams applications should be configured with a resource account. You can retrieve the Microsoft Entra bot object ID via the [Microsoft Graph REST API /users](/graph/api/user-list) endpoint from the `id` property in the response. For more information on how to work with Microsoft Graph, try the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer?request=users%2F%7Buser-mail%7D&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) and look into the [Graph SDK](/graph/sdks/sdks-overview).
7875

7976
#### Basic usage
8077

8178
```python
82-
# Get the Microsoft bot's ID from Graph APIs
79+
# Get the Microsoft Teams App's ID from Graph APIs
8380
users = graph_client.get("/users").json()
8481

8582
# Here we assume that you have a function get_bot_from_users that gets the bot from the returned response
8683
bot = get_bot_from_users(users);
8784

8885
# Create an identifier
89-
bot_identifier = MicrosoftBotIdentifier(bot_id=bot.get("id"))
86+
teams_app_identifier = MicrosoftTeamsAppIdentifier(app_id=bot.get("id"))
9087

9188
# If you're not operating in the public cloud, you must also pass the right Cloud type.
92-
# If you use Azure Bot Framework instead of Teams Voice applications, set property isResourceAccountConfigured to false.
93-
gcch_bot_identifier = MicrosoftBotIdentifier(
94-
bot_id=bot.get("id"),
95-
is_resource_account_configured=True,
89+
gcch_teams_app_identifier = MicrosoftTeamsAppIdentifier(
90+
app_id=bot.get("id"),
9691
cloud=CommunicationCloudEnvironment.GCCH
9792
)
9893
```
9994

10095
#### API reference
10196

102-
[MicrosoftBotIdentifier](/python/api/azure-communication-identity/azure.communication.identity.microsoftbotidentifier?view=azure-python-preview&preserve-view=true)
97+
[MicrosoftTeamsAppIdentifier](/python/api/azure-communication-identity/azure.communication.identity.microsoftteamsappidentifier)
10398

10499
### Unknown
105100

0 commit comments

Comments
 (0)