openapi-directory/api/azure.com/engagementfabric-EngagementFabric.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Microsoft Customer Engagement Fabric","title":"EngagementFabric","version":"2018-09-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/EngagementFabric.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"engagementfabric-EngagementFabric","x-tags":["Azure","Microsoft"]},"paths":{"/providers/Microsoft.EngagementFabric/operations":{"get":{"operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationList"},"examples":{"OperationsListExample":{"$ref":"#/components/examples/OperationsListExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"List operation of EngagementFabric resources","tags":["Operations"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/providers/Microsoft.EngagementFabric/Accounts":{"get":{"operationId":"Accounts_List","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"},"examples":{"AccountsListExample":{"$ref":"#/components/examples/AccountsListExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"List the EngagementFabric accounts in given subscription","tags":["Accounts"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/providers/Microsoft.EngagementFabric/skus":{"get":{"operationId":"SKUs_List","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkuDescriptionList"},"examples":{"SKUsListExample":{"$ref":"#/components/examples/SKUsListExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"List available SKUs of EngagementFabric resource","tags":["Skus"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts":{"get":{"operationId":"Accounts_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"},"examples":{"AccountsListByResourceGroupExample":{"$ref":"#/components/examples/AccountsListByResourceGroupExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"List EngagementFabric accounts in given resource group","tags":["Accounts"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}":{"delete":{"operationId":"Accounts_Delete","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK"},"204":{"description":"NoContent"},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Delete the EngagementFabric account","tags":["Accounts"]},"get":{"operationId":"Accounts_Get","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"},"examples":{"AccountsGetExample":{"$ref":"#/components/examples/AccountsGetExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Get the EngagementFabric account","tags":["Accounts"]},"patch":{"operationId":"Accounts_Update","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPatch"}}},"description":"The account patch","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"},"examples":{"AccountsUpdateExample":{"$ref":"#/components/examples/AccountsUpdateExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Update EngagementFabric account","tags":["Accounts"]},"put":{"operationId":"Accounts_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"The EngagementFabric account description","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"},"examples":{"AccountsCreateOrUpdateExample":{"$ref":"#/components/examples/AccountsCreateOrUpdateExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Create or Update the EngagementFabric account","tags":["Accounts"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels":{"get":{"operationId":"Channels_ListByAccount","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelList"},"examples":{"ChannelsListExample":{"$ref":"#/components/examples/ChannelsListExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"List the EngagementFabric channels","tags":["Channels"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels/{channelName}":{"delete":{"operationId":"Channels_Delete","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"description":"The EngagementFabric channel name","in":"path","name":"channelName","required":true,"schema":{"type":"string"},"examples":{"ChannelsDeleteExample":{"value":"ExampleChannel"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK"},"204":{"description":"NoContent"},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Delete the EngagementFabric channel","tags":["Channels"]},"get":{"operationId":"Channels_Get","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ChannelNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channel"},"examples":{"ChannelsGetExample":{"$ref":"#/components/examples/ChannelsGetExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Get the EngagementFabric channel","tags":["Channels"]},"put":{"operationId":"Channels_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ChannelNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channel"}}},"description":"The EngagementFabric channel description","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channel"},"examples":{"ChannelsCreateOrUpdateExample":{"$ref":"#/components/examples/ChannelsCreateOrUpdateExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Create or Update the EngagementFabric channel","tags":["Channels"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/listChannelTypes":{"post":{"operationId":"Accounts_ListChannelTypes","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTypeDescriptionList"},"examples":{"AccountsListChannelTypesExample":{"$ref":"#/components/examples/AccountsListChannelTypesExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"List available EngagementFabric channel types and functions","tags":["Accounts"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/listKeys":{"post":{"operationId":"Accounts_ListKeys","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyDescriptionList"},"examples":{"AccountsListKeysExample":{"$ref":"#/components/examples/AccountsListKeysExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"List keys of the EngagementFabric account","tags":["Accounts"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/regenerateKey":{"post":{"operationId":"Accounts_RegenerateKey","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegenerateKeyParameter"}}},"description":"Parameters specifying the key to be regenerated","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyDescription"},"examples":{"AccountsRegenerateKeyExample":{"$ref":"#/components/examples/AccountsRegenerateKeyExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Regenerate key of the EngagementFabric account","tags":["Accounts"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/checkNameAvailability":{"post":{"operationId":"CheckNameAvailability","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityParameter"}}},"description":"Parameter describing the name to be checked","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityResult"},"examples":{"CheckNameAvailabilityExample":{"$ref":"#/components/examples/CheckNameAvailabilityExample"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Check availability of EngagementFabric resource","tags":["NameAvailability"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"OperationsListExample":{"value":{"value":[{"display":{"description":"List or get the EngagementFabric account","operation":"List or get the EngagementFabric account","provider":"Microsoft Customer Engagement Fabric","resource":"Accounts"},"name":"Microsoft.EngagementFabric/Accounts/read"},{"display":{"description":"Create or update the EngagementFabric account","operation":"Create or update the EngagementFabric account","provider":"Microsoft Customer Engagement Fabric","resource":"Accounts"},"name":"Microsoft.EngagementFabric/Accounts/write"},{"display":{"description":"Delete the EngagementFabric account","operation":"Delete the EngagementFabric account","provider":"Microsoft Customer Engagement Fabric","resource":"Accounts"},"name":"Microsoft.EngagementFabric/Accounts/delete"},{"display":{"description":"Get all keys of the EngagementFabric account","operation":"Get all keys of the EngagementFabric account","provider":"Microsoft Customer Engagement Fabric","resource":"Accounts"},"name":"Microsoft.EngagementFabric/Accounts/ListKeys/action"},{"display":{"description":"Regenerate the EngagementFabric account key","operation":"Regenerate the EngagementFabric account key","provider":"Microsoft Customer Engagement Fabric","resource":"Accounts"},"name":"Microsoft.EngagementFabric/Accounts/RegenerateKey/action"},{"display":{"description":"List available EngagementFabric channel types and functions","operation":"List available EngagementFabric channel types and functions","provider":"Microsoft Customer Engagement Fabric","resource":"Accounts"},"name":"Microsoft.EngagementFabric/Accounts/ListChannelTypes/action"},{"display":{"description":"List or get the EngagementFabric channel","operation":"List or get the EngagementFabric channel","provider":"Microsoft Customer Engagement Fabric","resource":"Channels"},"name":"Microsoft.EngagementFabric/Accounts/Channels/read"},{"display":{"description":"Create or update the EngagementFabric channel","operation":"Create or update the EngagementFabric channel","provider":"Microsoft Customer Engagement Fabric","resource":"Channels"},"name":"Microsoft.EngagementFabric/Accounts/Channels/write"},{"display":{"description":"Delete the EngagementFabric channel","operation":"Delete the EngagementFabric channel","provider":"Microsoft Customer Engagement Fabric","resource":"Channels"},"name":"Microsoft.EngagementFabric/Accounts/Channels/delete"},{"display":{"description":"Check name availability","operation":"Check name availability","provider":"Microsoft Customer Engagement Fabric","resource":"Accounts"},"name":"Microsoft.EngagementFabric/checkNameAvailability/action"},{"display":{"description":"List available operations","operation":"List available operations","provider":"Microsoft Customer Engagement Fabric","resource":"Operations"},"name":"Microsoft.EngagementFabric/operations/read"},{"display":{"description":"List available SKUs","operation":"List available SKUs","provider":"Microsoft Customer Engagement Fabric","resource":"Accounts"},"name":"Microsoft.EngagementFabric/skus/read"}]}},"AccountsListExample":{"value":{"value":[{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount","location":"WestUS","name":"ExampleAccount","sku":{"name":"B1","tier":"Basic"},"type":"Microsoft.EngagementFabric/Accounts"},{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount2","location":"WestUS","name":"ExampleAccount2","sku":{"name":"S1","tier":"Standard"},"type":"Microsoft.EngagementFabric/Accounts"},{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount3","location":"WestUS","name":"ExampleAccount3","sku":{"name":"P1","tier":"Premium"},"type":"Microsoft.EngagementFabric/Accounts"}]}},"SKUsListExample":{"value":{"value":[{"locationInfo":[{"location":"Central US"},{"location":"North Europe"},{"location":"West Europe"}],"locations":["Central US","North Europe","West Europe"],"name":"B1","resourceType":"Microsoft.EngagementFabric/Accounts","restrictions":[],"tier":"Basic"},{"locationInfo":[{"location":"Central US"},{"location":"North Europe"},{"location":"West Europe"}],"locations":["Central US","North Europe","West Europe"],"name":"S1","resourceType":"Microsoft.EngagementFabric/Accounts","restrictions":[],"tier":"Standard"},{"locationInfo":[{"location":"Central US"},{"location":"North Europe"},{"location":"West Europe"}],"locations":["Central US","North Europe","West Europe"],"name":"P1","resourceType":"Microsoft.EngagementFabric/Accounts","restrictions":[],"tier":"Premium"}]}},"AccountsListByResourceGroupExample":{"value":{"value":[{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount","location":"WestUS","name":"ExampleAccount","sku":{"name":"B1","tier":"Basic"},"type":"Microsoft.EngagementFabric/Accounts"},{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount2","location":"WestUS","name":"ExampleAccount2","sku":{"name":"S1","tier":"Standard"},"type":"Microsoft.EngagementFabric/Accounts"},{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount3","location":"WestUS","name":"ExampleAccount3","sku":{"name":"P1","tier":"Premium"},"type":"Microsoft.EngagementFabric/Accounts"}]}},"AccountsGetExample":{"value":{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount","location":"WestUS","name":"ExampleAccount","sku":{"name":"B1","tier":"Basic"},"type":"Microsoft.EngagementFabric/Accounts"}},"AccountsUpdateExample":{"value":{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount","location":"WestUS","name":"ExampleAccount","sku":{"name":"B1","tier":"Basic"},"tags":{"tagName":"tagValue"},"type":"Microsoft.EngagementFabric/Accounts"}},"AccountsCreateOrUpdateExample":{"value":{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount","location":"WestUS","name":"ExampleAccount","sku":{"name":"B1","tier":"Basic"},"type":"Microsoft.EngagementFabric/Accounts"}},"ChannelsListExample":{"value":{"value":[{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount/Channels/ExampleChannel","name":"ExampleChannel","properties":{"channelFunctions":["MockFunction1","MockFunction2"],"channelType":"MockChannel","credentials":{"AppId":"exampleApp","AppKey":""}},"type":"Microsoft.EngagementFabric/Accounts/Channels"},{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount/Channels/ExampleChannel2","name":"ExampleChannel2","properties":{"channelFunctions":["MockFunction1","MockFunction3"],"channelType":"MockChannel2","credentials":{"AppId":"exampleApp2","AppKey":""}},"type":"Microsoft.EngagementFabric/Accounts/Channels"}]}},"ChannelsGetExample":{"value":{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount/Channels/ExampleChannel","name":"ExampleChannel","properties":{"channelFunctions":["MockFunction1","MockFunction2"],"channelType":"MockChannel","credentials":{"AppId":"exampleApp","AppKey":""}},"type":"Microsoft.EngagementFabric/Accounts/Channels"}},"ChannelsCreateOrUpdateExample":{"value":{"id":"subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount/Channels/ExampleChannel","name":"ExampleChannel","properties":{"channelFunctions":["MockFunction1","MockFunction2"],"channelType":"MockChannel","credentials":{"AppId":"exampleApp","AppKey":""}},"type":"Microsoft.EngagementFabric/Accounts/Channels"}},"AccountsListChannelTypesExample":{"value":{"value":[{"channelDescription":"Description of mockChannel1","channelFunctions":["MockFunction1","MockFunction2"],"channelType":"MockChannel1"},{"channelDescription":"Description of mockChannel2","channelFunctions":["MockFunction1","MockFunction3"],"channelType":"MockChannel2"},{"channelDescription":"Description of mockChannel3","channelFunctions":["MockFunction1","MockFunction2","MockFunction3"],"channelType":"MockChannel3"}]}},"AccountsListKeysExample":{"value":{"value":[{"name":"Full","rank":"PrimaryKey","value":"<ExampleFullPrimaryKeyValue>"},{"name":"Full","rank":"SecondaryKey","value":"<ExampleFullSecondaryKeyValue>"},{"name":"Device","rank":"PrimaryKey","value":"<ExampleDevicePrimaryKeyValue>"},{"name":"Device","rank":"SecondaryKey","value":"<ExampleDeviceSecondaryKeyValue>"}]}},"AccountsRegenerateKeyExample":{"value":{"name":"Full","rank":"PrimaryKey","value":"<ExampleFullPrimaryKeyValue>"}},"CheckNameAvailabilityExample":{"value":{"message":"Account 'ExampleAccount' already exists","nameAvailable":false,"reason":"AlreadyExists"}}},"parameters":{"AccountNameParameter":{"description":"Account Name","in":"path","name":"accountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"AccountsDeleteExample":{"value":"ExampleAccount"},"AccountsGetExample":{"value":"ExampleAccount"},"AccountsUpdateExample":{"value":"ExampleAccount"},"AccountsCreateOrUpdateExample":{"value":"ExampleAccount"},"ChannelsListExample":{"value":"ExampleAccount"},"ChannelsDeleteExample":{"value":"ExampleAccount"},"ChannelsGetExample":{"value":"ExampleAccount"},"ChannelsCreateOrUpdateExample":{"value":"ExampleAccount"},"AccountsListChannelTypesExample":{"value":"ExampleAccount"},"AccountsListKeysExample":{"value":"ExampleAccount"},"AccountsRegenerateKeyExample":{"value":"ExampleAccount"}}},"ApiVersionParameter":{"description":"API version","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"OperationsListExample":{"value":"2018-09-01-preview"},"AccountsListExample":{"value":"2018-09-01-preview"},"SKUsListExample":{"value":"2018-09-01-preview"},"AccountsListByResourceGroupExample":{"value":"2018-09-01-preview"},"AccountsDeleteExample":{"value":"2018-09-01-preview"},"AccountsGetExample":{"value":"2018-09-01-preview"},"AccountsUpdateExample":{"value":"2018-09-01-preview"},"AccountsCreateOrUpdateExample":{"value":"2018-09-01-preview"},"ChannelsListExample":{"value":"2018-09-01-preview"},"ChannelsDeleteExample":{"value":"2018-09-01-preview"},"ChannelsGetExample":{"value":"2018-09-01-preview"},"ChannelsCreateOrUpdateExample":{"value":"2018-09-01-preview"},"AccountsListChannelTypesExample":{"value":"2018-09-01-preview"},"AccountsListKeysExample":{"value":"2018-09-01-preview"},"AccountsRegenerateKeyExample":{"value":"2018-09-01-preview"},"CheckNameAvailabilityExample":{"value":"2018-09-01-preview"}}},"ChannelNameParameter":{"description":"Channel Name","in":"path","name":"channelName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ChannelsGetExample":{"value":"ExampleChannel"},"ChannelsCreateOrUpdateExample":{"value":"ExampleChannel"}}},"ResourceGroupNameParameter":{"description":"Resource Group Name","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"AccountsListByResourceGroupExample":{"value":"ExampleRg"},"AccountsDeleteExample":{"value":"ExampleRg"},"AccountsGetExample":{"value":"ExampleRg"},"AccountsUpdateExample":{"value":"ExampleRg"},"AccountsCreateOrUpdateExample":{"value":"ExampleRg"},"ChannelsListExample":{"value":"ExampleRg"},"ChannelsDeleteExample":{"value":"ExampleRg"},"ChannelsGetExample":{"value":"ExampleRg"},"ChannelsCreateOrUpdateExample":{"value":"ExampleRg"},"AccountsListChannelTypesExample":{"value":"ExampleRg"},"AccountsListKeysExample":{"value":"ExampleRg"},"AccountsRegenerateKeyExample":{"value":"ExampleRg"}}},"SubscriptionIdParameter":{"description":"Subscription ID","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"AccountsListExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"SKUsListExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"AccountsListByResourceGroupExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"AccountsDeleteExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"AccountsGetExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"AccountsUpdateExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"AccountsCreateOrUpdateExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"ChannelsListExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"ChannelsDeleteExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"ChannelsGetExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"ChannelsCreateOrUpdateExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"AccountsListChannelTypesExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"AccountsListKeysExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"AccountsRegenerateKeyExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"},"CheckNameAvailabilityExample":{"value":"EDBF0095-A524-4A84-95FB-F72DA41AA6A1"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"Account":{"allOf":[{"$ref":"#/components/schemas/TrackedResource"}],"description":"The EngagementFabric account","required":["location","sku"],"type":"object"},"AccountList":{"description":"The list of the EngagementFabric accounts","properties":{"value":{"description":"EngagementFabric accounts","items":{"$ref":"#/components/schemas/Account"},"type":"array"}},"type":"object"},"AccountPatch":{"description":"The patch of EngagementFabric account","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"The tags of the resource","type":"object"}},"type":"object"},"Channel":{"allOf":[{"$ref":"#/components/schemas/ProxyOnlyResource"}],"description":"The EngagementFabric channel","properties":{"properties":{"$ref":"#/components/schemas/ChannelProperties"}},"type":"object"},"ChannelList":{"description":"The list of the EngagementFabric channels","properties":{"value":{"description":"EngagementFabric channels","items":{"$ref":"#/components/schemas/Channel"},"type":"array"}},"type":"object"},"ChannelProperties":{"description":"The EngagementFabric channel properties","properties":{"channelFunctions":{"description":"The functions to be enabled for the channel","items":{"type":"string"},"type":"array"},"channelType":{"description":"The channel type","type":"string"},"credentials":{"additionalProperties":{"type":"string"},"description":"The channel credentials","type":"object"}},"required":["channelType"],"type":"object"},"ChannelTypeDescription":{"description":"EngagementFabric channel description","properties":{"channelDescription":{"description":"Text description for the channel","type":"string"},"channelFunctions":{"description":"All the available functions for the channel","items":{"type":"string"},"type":"array"},"channelType":{"description":"Channel type","type":"string"}},"type":"object"},"ChannelTypeDescriptionList":{"description":"List of the EngagementFabric channel descriptions","properties":{"value":{"description":"Channel descriptions","items":{"$ref":"#/components/schemas/ChannelTypeDescription"},"type":"array"}},"type":"object"},"CheckNameAvailabilityParameter":{"description":"The parameter for name availability check","properties":{"name":{"description":"The name to be checked","type":"string"},"type":{"description":"The fully qualified resource type for the name to be checked","type":"string"}},"required":["name","type"],"type":"object"},"CheckNameAvailabilityResult":{"description":"The result of name availability check","properties":{"message":{"description":"The message if name is unavailable","readOnly":true,"type":"string"},"nameAvailable":{"description":"The name to be checked","readOnly":true,"type":"boolean"},"reason":{"$ref":"#/components/schemas/CheckNameUnavailableReason"}},"type":"object"},"CheckNameUnavailableReason":{"description":"The reason of name availability result","enum":["Invalid","AlreadyExists"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"CheckNameUnavailableReason"}},"CloudError":{"description":"The default error response","properties":{"error":{"$ref":"#/components/schemas/CloudErrorBody"}},"type":"object","x-ms-external":true},"CloudErrorBody":{"description":"Content of the default error response","properties":{"code":{"description":"The error code","type":"string"},"details":{"description":"The list of additional details","items":{"$ref":"#/components/schemas/CloudErrorBody"},"type":"array"},"message":{"description":"The error message","type":"string"},"target":{"description":"The target of the particular error","type":"string"}},"type":"object","x-ms-external":true},"KeyDescription":{"description":"The description of the EngagementFabric account key","properties":{"name":{"description":"The name of the key","readOnly":true,"type":"string"},"rank":{"$ref":"#/components/schemas/KeyRank"},"value":{"description":"The value of the key","readOnly":true,"type":"string"}},"type":"object"},"KeyDescriptionList":{"description":"The list of the EngagementFabric account keys","properties":{"value":{"description":"Account keys","items":{"$ref":"#/components/schemas/KeyDescription"},"readOnly":true,"type":"array"}},"type":"object"},"KeyRank":{"description":"The rank of the EngagementFabric account key","enum":["PrimaryKey","SecondaryKey"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"KeyRank"}},"Operation":{"description":"The EngagementFabric operation","properties":{"display":{"$ref":"#/components/schemas/OperationDisplay"},"name":{"description":"The name of the EngagementFabric operation","readOnly":true,"type":"string"}},"type":"object"},"OperationDisplay":{"description":"The display information of the EngagementFabric operation","properties":{"description":{"description":"The description of the EngagementFabric operation","readOnly":true,"type":"string"},"operation":{"description":"The name of the EngagementFabric operation","readOnly":true,"type":"string"},"provider":{"description":"The resource provider namespace of the EngagementFabric operation","readOnly":true,"type":"string"},"resource":{"description":"The resource type of the EngagementFabric operation","readOnly":true,"type":"string"}},"type":"object"},"OperationList":{"description":"The list of the EngagementFabric operations","properties":{"value":{"description":"The EngagementFabric operations","items":{"$ref":"#/components/schemas/Operation"},"readOnly":true,"type":"array"}},"type":"object"},"ProxyOnlyResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"The base model for the proxy-only Azure resource","type":"object"},"RegenerateKeyParameter":{"description":"The parameter to regenerate single EngagementFabric account key","properties":{"name":{"description":"The name of key to be regenerated","type":"string"},"rank":{"$ref":"#/components/schemas/KeyRank"}},"required":["name","rank"],"type":"object"},"Resource":{"description":"The base model for Azure resource","properties":{"id":{"description":"The ID of the resource","readOnly":true,"type":"string"},"name":{"description":"The name of the resource","readOnly":true,"type":"string"},"type":{"description":"The fully qualified type of the resource","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true},"SKU":{"description":"The EngagementFabric SKU","properties":{"name":{"description":"The name of the SKU","type":"string"},"tier":{"description":"The price tier of the SKU","type":"string"}},"required":["name"],"type":"object"},"SkuDescription":{"description":"The EngagementFabric SKU description of given resource type","properties":{"locationInfo":{"description":"Locations and zones","items":{"$ref":"#/components/schemas/SkuLocationInfoItem"},"readOnly":true,"type":"array"},"locations":{"description":"The set of locations that the SKU is available","items":{"type":"string"},"readOnly":true,"type":"array"},"name":{"description":"The name of the SKU","readOnly":true,"type":"string"},"resourceType":{"description":"The fully qualified resource type","readOnly":true,"type":"string"},"restrictions":{"description":"The restrictions because of which SKU cannot be used","items":{"type":"object"},"readOnly":true,"type":"array"},"tier":{"description":"The price tier of the SKU","readOnly":true,"type":"string"}},"type":"object"},"SkuDescriptionList":{"description":"The list of the EngagementFabric SKU descriptions","properties":{"value":{"description":"SKU descriptions","items":{"$ref":"#/components/schemas/SkuDescription"},"readOnly":true,"type":"array"}},"type":"object"},"SkuLocationInfoItem":{"description":"The Locations and zones info for SKU","properties":{"location":{"description":"The available location of the SKU","type":"string"},"zones":{"description":"The available zone of the SKU","items":{"type":"string"},"type":"array"}},"type":"object"},"TrackedResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"The base model for the tracked Azure resource","properties":{"location":{"description":"The location of the resource","type":"string","x-ms-mutability":["create","read"]},"sku":{"$ref":"#/components/schemas/SKU"},"tags":{"additionalProperties":{"type":"string"},"description":"The tags of the resource","type":"object"}},"required":["location","sku"],"type":"object"}}}}