Microsoft.EngagementFabric (preview:2018-09-01)

2025/09/26 • 16 new, 16 deleted methods

Accounts_Get (new)
Description :  Get the EngagementFabric account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The EngagementFabric account ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_CreateOrUpdate (new)
Description :  Create or Update the EngagementFabric account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
account:
{
Description: The EngagementFabric account description ,
Required: True ,
}
object ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The EngagementFabric account ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_Delete (new)
Description :  Delete the EngagementFabric account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_Update (new)
Description :  Update EngagementFabric account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
accountPatch:
{
Description: The account patch ,
Required: True ,
}
{
tags:
{
Description: The tags of the resource ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The EngagementFabric account ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_List (new)
Description :  List the EngagementFabric accounts in given subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EngagementFabric/Accounts
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: EngagementFabric accounts ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_ListByResourceGroup (new)
Description :  List EngagementFabric accounts in given resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: EngagementFabric accounts ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_ListKeys (new)
Description :  List keys of the EngagementFabric account
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/listKeys
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Account keys ,
Required: False ,
}
[
{
name:
{
Description: The name of the key ,
Required: False ,
}
string ,
rank:
{
Description: The rank of the key ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_RegenerateKey (new)
Description :  Regenerate key of the EngagementFabric account
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/regenerateKey
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
parameter:
{
Description: Parameters specifying the key to be regenerated ,
Required: True ,
}
{
name:
{
Description: The name of key to be regenerated ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the key to be regenerated ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the key ,
Required: False ,
}
string ,
rank:
{
Description: The rank of the key ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_ListChannelTypes (new)
Description :  List available EngagementFabric channel types and functions
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/listChannelTypes
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Channel descriptions ,
Required: False ,
}
[
{
channelType:
{
Description: Channel type ,
Required: False ,
}
string ,
channelDescription:
{
Description: Text description for the channel ,
Required: False ,
}
string ,
channelFunctions:
{
Description: All the available functions for the channel ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Channels_Get (new)
Description :  Get the EngagementFabric channel
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels/{channelName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
channelName:
{
Description: Channel Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the channel ,
Required: False ,
}
{
channelType:
{
Description: The channel type ,
Required: True ,
}
string ,
channelFunctions:
{
Description: The functions to be enabled for the channel ,
Required: False ,
}
[
string ,
]
,
credentials:
{
Description: The channel credentials ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Channels_CreateOrUpdate (new)
Description :  Create or Update the EngagementFabric channel
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels/{channelName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
channelName:
{
Description: Channel Name ,
Required: True ,
}
string ,
channel:
{
Description: The EngagementFabric channel description ,
Required: True ,
}
{
properties:
{
Description: The properties of the channel ,
Required: False ,
}
{
channelType:
{
Description: The channel type ,
Required: True ,
}
string ,
channelFunctions:
{
Description: The functions to be enabled for the channel ,
Required: False ,
}
[
string ,
]
,
credentials:
{
Description: The channel credentials ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the channel ,
Required: False ,
}
{
channelType:
{
Description: The channel type ,
Required: True ,
}
string ,
channelFunctions:
{
Description: The functions to be enabled for the channel ,
Required: False ,
}
[
string ,
]
,
credentials:
{
Description: The channel credentials ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Channels_Delete (new)
Description :  Delete the EngagementFabric channel
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels/{channelName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
channelName:
{
Description: The EngagementFabric channel name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Channels_ListByAccount (new)
Description :  List the EngagementFabric channels
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: EngagementFabric channels ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the channel ,
Required: False ,
}
{
channelType:
{
Description: The channel type ,
Required: True ,
}
string ,
channelFunctions:
{
Description: The functions to be enabled for the channel ,
Required: False ,
}
[
string ,
]
,
credentials:
{
Description: The channel credentials ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
CheckNameAvailability (new)
Description :  Check availability of EngagementFabric resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/checkNameAvailability
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameter describing the name to be checked ,
Required: True ,
}
{
name:
{
Description: The name to be checked ,
Required: True ,
}
string ,
type:
{
Description: The fully qualified resource type for the name to be checked ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The name to be checked ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason if name is unavailable ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message if name is unavailable ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (new)
Description :  List operation of EngagementFabric resources
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EngagementFabric/operations
{
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EngagementFabric operations ,
Required: False ,
}
[
{
name:
{
Description: The name of the EngagementFabric operation ,
Required: False ,
}
string ,
display:
{
Description: The display content of the EngagementFabric operation ,
Required: False ,
}
{
provider:
{
Description: The resource provider namespace of the EngagementFabric operation ,
Required: False ,
}
string ,
resource:
{
Description: The resource type of the EngagementFabric operation ,
Required: False ,
}
string ,
operation:
{
Description: The name of the EngagementFabric operation ,
Required: False ,
}
string ,
description:
{
Description: The description of the EngagementFabric operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
SKUs_List (new)
Description :  List available SKUs of EngagementFabric resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EngagementFabric/skus
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: SKU descriptions ,
Required: False ,
}
[
{
resourceType:
{
Description: The fully qualified resource type ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU ,
Required: False ,
}
string ,
tier:
{
Description: The price tier of the SKU ,
Required: False ,
}
string ,
locations:
{
Description: The set of locations that the SKU is available ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: Locations and zones ,
Required: False ,
}
[
{
location:
{
Description: The available location of the SKU ,
Required: False ,
}
string ,
zones:
{
Description: The available zone of the SKU ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
restrictions:
{
Description: The restrictions because of which SKU cannot be used ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_Get (removed)
Description :  Get the EngagementFabric account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The EngagementFabric account ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_CreateOrUpdate (removed)
Description :  Create or Update the EngagementFabric account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
account:
{
Description: The EngagementFabric account description ,
Required: True ,
}
object ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The EngagementFabric account ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_Delete (removed)
Description :  Delete the EngagementFabric account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_Update (removed)
Description :  Update EngagementFabric account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
accountPatch:
{
Description: The account patch ,
Required: True ,
}
{
tags:
{
Description: The tags of the resource ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The EngagementFabric account ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_List (removed)
Description :  List the EngagementFabric accounts in given subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EngagementFabric/Accounts
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: EngagementFabric accounts ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_ListByResourceGroup (removed)
Description :  List EngagementFabric accounts in given resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: EngagementFabric accounts ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_ListKeys (removed)
Description :  List keys of the EngagementFabric account
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/listKeys
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Account keys ,
Required: False ,
}
[
{
name:
{
Description: The name of the key ,
Required: False ,
}
string ,
rank:
{
Description: The rank of the key ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_RegenerateKey (removed)
Description :  Regenerate key of the EngagementFabric account
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/regenerateKey
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
parameter:
{
Description: Parameters specifying the key to be regenerated ,
Required: True ,
}
{
name:
{
Description: The name of key to be regenerated ,
Required: True ,
}
string ,
rank:
{
Description: The rank of the key to be regenerated ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the key ,
Required: False ,
}
string ,
rank:
{
Description: The rank of the key ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_ListChannelTypes (removed)
Description :  List available EngagementFabric channel types and functions
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/listChannelTypes
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Channel descriptions ,
Required: False ,
}
[
{
channelType:
{
Description: Channel type ,
Required: False ,
}
string ,
channelDescription:
{
Description: Text description for the channel ,
Required: False ,
}
string ,
channelFunctions:
{
Description: All the available functions for the channel ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Channels_Get (removed)
Description :  Get the EngagementFabric channel
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels/{channelName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
channelName:
{
Description: Channel Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the channel ,
Required: False ,
}
{
channelType:
{
Description: The channel type ,
Required: True ,
}
string ,
channelFunctions:
{
Description: The functions to be enabled for the channel ,
Required: False ,
}
[
string ,
]
,
credentials:
{
Description: The channel credentials ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Channels_CreateOrUpdate (removed)
Description :  Create or Update the EngagementFabric channel
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels/{channelName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
channelName:
{
Description: Channel Name ,
Required: True ,
}
string ,
channel:
{
Description: The EngagementFabric channel description ,
Required: True ,
}
{
properties:
{
Description: The properties of the channel ,
Required: False ,
}
{
channelType:
{
Description: The channel type ,
Required: True ,
}
string ,
channelFunctions:
{
Description: The functions to be enabled for the channel ,
Required: False ,
}
[
string ,
]
,
credentials:
{
Description: The channel credentials ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the channel ,
Required: False ,
}
{
channelType:
{
Description: The channel type ,
Required: True ,
}
string ,
channelFunctions:
{
Description: The functions to be enabled for the channel ,
Required: False ,
}
[
string ,
]
,
credentials:
{
Description: The channel credentials ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Channels_Delete (removed)
Description :  Delete the EngagementFabric channel
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels/{channelName}
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
channelName:
{
Description: The EngagementFabric channel name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Channels_ListByAccount (removed)
Description :  List the EngagementFabric channels
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
accountName:
{
Description: Account Name ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: EngagementFabric channels ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the channel ,
Required: False ,
}
{
channelType:
{
Description: The channel type ,
Required: True ,
}
string ,
channelFunctions:
{
Description: The functions to be enabled for the channel ,
Required: False ,
}
[
string ,
]
,
credentials:
{
Description: The channel credentials ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
CheckNameAvailability (removed)
Description :  Check availability of EngagementFabric resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/checkNameAvailability
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameter describing the name to be checked ,
Required: True ,
}
{
name:
{
Description: The name to be checked ,
Required: True ,
}
string ,
type:
{
Description: The fully qualified resource type for the name to be checked ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The name to be checked ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason if name is unavailable ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message if name is unavailable ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  List operation of EngagementFabric resources
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.EngagementFabric/operations
{
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EngagementFabric operations ,
Required: False ,
}
[
{
name:
{
Description: The name of the EngagementFabric operation ,
Required: False ,
}
string ,
display:
{
Description: The display content of the EngagementFabric operation ,
Required: False ,
}
{
provider:
{
Description: The resource provider namespace of the EngagementFabric operation ,
Required: False ,
}
string ,
resource:
{
Description: The resource type of the EngagementFabric operation ,
Required: False ,
}
string ,
operation:
{
Description: The name of the EngagementFabric operation ,
Required: False ,
}
string ,
description:
{
Description: The description of the EngagementFabric operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}
SKUs_List (removed)
Description :  List available SKUs of EngagementFabric resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EngagementFabric/skus
{
subscriptionId:
{
Description: Subscription ID ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: SKU descriptions ,
Required: False ,
}
[
{
resourceType:
{
Description: The fully qualified resource type ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU ,
Required: False ,
}
string ,
tier:
{
Description: The price tier of the SKU ,
Required: False ,
}
string ,
locations:
{
Description: The set of locations that the SKU is available ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: Locations and zones ,
Required: False ,
}
[
{
location:
{
Description: The available location of the SKU ,
Required: False ,
}
string ,
zones:
{
Description: The available zone of the SKU ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
restrictions:
{
Description: The restrictions because of which SKU cannot be used ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Content of the error ,
Required: False ,
}
{
code:
{
Description: The error code ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: The list of additional details ,
Required: False ,
}
[
string ,
]
,
}
,
}