Post
/AzureDocumenter/AddDocumentConfiguration
Security
API Key: APIKey
Header parameter nameAPIKey
API key which has access for your API
Body parameters
object
name
string
description
string
azureDocumenterGroupId
string (uuid)
isAddNewServicePrincipal
boolean
servicePrincipalDetails
object (ServicePrincipalDetails)
friendlyName
string
tenantId
string (uuid)
clientId
string (uuid)
clientSecret
string
clientSecretExpirationDate
string (date-time)
platformId
string (uuid)
projectName
string
accessToken
string
publishType
integer (int32)
connectionString
string
selectedNotificationChannels
Array of string
string (uuid)
isNotification
boolean
recipientEmailAddress
string
recipientTemplateId
string (uuid)
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
recipientEmailIds
Array of string
string
emailSubject
string
documentType
integer (int32)
selectedSubscriptions
Array of object (SelectedSubscription)
object
subscriptionId
string (uuid)
clientId
string (uuid)
scopeFilters
Array of string
string
filtersConfiguration
object (FiltersConfiguration)
description
string
includeResourceLevelProperties
boolean
includeCharts
boolean
policies
Array of object (PolicyItem)
object
assignmentId
string
assignmentName
string
clientId
string (uuid)
subscriptionId
string (uuid)
policyStates
Array of string
string
ignorableCost
number
filterBy
Array of object (FilterByItem)
object
filterType
integer (int32)
servicePrincipal
object (FilterServicePrincipal)
clientId
string (uuid)
subscriptionId
string (uuid)
tenantId
string (uuid)
subscriptionName
string
filterValues
Array of string
string
tagKey
string
resourceType
string
accessTypes
Array of string
string
roleType
Array of string
string
recommendations
Array of string
string
reservationRecommendations
Array of string
string
carbonScopes
Array of string
string
documentFormat
integer (int32)
documentParameters
object (DocumentParameters)
selectedBillingDateRangeTypeName
string
selectedBillingDateRangeTypeName1
string
customDateRange1
integer (int32)
customDateRange2
integer (int32)
customFromDate
string
customToDate
string
customFromDate1
string
customToDate1
string
includeResourceGroup
boolean
accessDetailsGroupBy
integer (int32)
currencyType
integer (int32)
accessTypes
Array of integer
integer (int32)
selectedDiagramType
integer (int32)
carbonReportType
integer (int32)
carbonSummaryGroupBy
integer (int32)
office365ReportType
integer (int32)
styling
object (DocumentStyling)
accentColour
string
logoReference
string
logoFileName
string
object
name
string
description
string
azureDocumenterGroupId
string (uuid)
isAddNewServicePrincipal
boolean
servicePrincipalDetails
object (ServicePrincipalDetails)
friendlyName
string
tenantId
string (uuid)
clientId
string (uuid)
clientSecret
string
clientSecretExpirationDate
string (date-time)
platformId
string (uuid)
projectName
string
accessToken
string
publishType
integer (int32)
connectionString
string
selectedNotificationChannels
Array of string
string (uuid)
isNotification
boolean
recipientEmailAddress
string
recipientTemplateId
string (uuid)
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
recipientEmailIds
Array of string
string
emailSubject
string
documentType
integer (int32)
selectedSubscriptions
Array of object (SelectedSubscription)
object
subscriptionId
string (uuid)
clientId
string (uuid)
scopeFilters
Array of string
string
filtersConfiguration
object (FiltersConfiguration)
description
string
includeResourceLevelProperties
boolean
includeCharts
boolean
policies
Array of object (PolicyItem)
object
assignmentId
string
assignmentName
string
clientId
string (uuid)
subscriptionId
string (uuid)
policyStates
Array of string
string
ignorableCost
number
filterBy
Array of object (FilterByItem)
object
filterType
integer (int32)
servicePrincipal
object (FilterServicePrincipal)
clientId
string (uuid)
subscriptionId
string (uuid)
tenantId
string (uuid)
subscriptionName
string
filterValues
Array of string
string
tagKey
string
resourceType
string
accessTypes
Array of string
string
roleType
Array of string
string
recommendations
Array of string
string
reservationRecommendations
Array of string
string
carbonScopes
Array of string
string
documentFormat
integer (int32)
documentParameters
object (DocumentParameters)
selectedBillingDateRangeTypeName
string
selectedBillingDateRangeTypeName1
string
customDateRange1
integer (int32)
customDateRange2
integer (int32)
customFromDate
string
customToDate
string
customFromDate1
string
customToDate1
string
includeResourceGroup
boolean
accessDetailsGroupBy
integer (int32)
currencyType
integer (int32)
accessTypes
Array of integer
integer (int32)
selectedDiagramType
integer (int32)
carbonReportType
integer (int32)
carbonSummaryGroupBy
integer (int32)
office365ReportType
integer (int32)
styling
object (DocumentStyling)
accentColour
string
logoReference
string
logoFileName
string
object
name
string
description
string
azureDocumenterGroupId
string (uuid)
isAddNewServicePrincipal
boolean
servicePrincipalDetails
object (ServicePrincipalDetails)
friendlyName
string
tenantId
string (uuid)
clientId
string (uuid)
clientSecret
string
clientSecretExpirationDate
string (date-time)
platformId
string (uuid)
projectName
string
accessToken
string
publishType
integer (int32)
connectionString
string
selectedNotificationChannels
Array of string
string (uuid)
isNotification
boolean
recipientEmailAddress
string
recipientTemplateId
string (uuid)
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
recipientEmailIds
Array of string
string
emailSubject
string
documentType
integer (int32)
selectedSubscriptions
Array of object (SelectedSubscription)
object
subscriptionId
string (uuid)
clientId
string (uuid)
scopeFilters
Array of string
string
filtersConfiguration
object (FiltersConfiguration)
description
string
includeResourceLevelProperties
boolean
includeCharts
boolean
policies
Array of object (PolicyItem)
object
assignmentId
string
assignmentName
string
clientId
string (uuid)
subscriptionId
string (uuid)
policyStates
Array of string
string
ignorableCost
number
filterBy
Array of object (FilterByItem)
object
filterType
integer (int32)
servicePrincipal
object (FilterServicePrincipal)
clientId
string (uuid)
subscriptionId
string (uuid)
tenantId
string (uuid)
subscriptionName
string
filterValues
Array of string
string
tagKey
string
resourceType
string
accessTypes
Array of string
string
roleType
Array of string
string
recommendations
Array of string
string
reservationRecommendations
Array of string
string
carbonScopes
Array of string
string
documentFormat
integer (int32)
documentParameters
object (DocumentParameters)
selectedBillingDateRangeTypeName
string
selectedBillingDateRangeTypeName1
string
customDateRange1
integer (int32)
customDateRange2
integer (int32)
customFromDate
string
customToDate
string
customFromDate1
string
customToDate1
string
includeResourceGroup
boolean
accessDetailsGroupBy
integer (int32)
currencyType
integer (int32)
accessTypes
Array of integer
integer (int32)
selectedDiagramType
integer (int32)
carbonReportType
integer (int32)
carbonSummaryGroupBy
integer (int32)
office365ReportType
integer (int32)
styling
object (DocumentStyling)
accentColour
string
logoReference
string
logoFileName
string
object
name
string
description
string
azureDocumenterGroupId
string (uuid)
isAddNewServicePrincipal
boolean
servicePrincipalDetails
object (ServicePrincipalDetails)
friendlyName
string
tenantId
string (uuid)
clientId
string (uuid)
clientSecret
string
clientSecretExpirationDate
string (date-time)
platformId
string (uuid)
projectName
string
accessToken
string
publishType
integer (int32)
connectionString
string
selectedNotificationChannels
Array of string
string (uuid)
isNotification
boolean
recipientEmailAddress
string
recipientTemplateId
string (uuid)
channelTemplateMapping
Array of object (ChannelTemplateMapping)
object
configuredChannelId
string (uuid)
customMailTemplateId
string (uuid)
recipientEmailIds
Array of string
string
emailSubject
string
documentType
integer (int32)
selectedSubscriptions
Array of object (SelectedSubscription)
object
subscriptionId
string (uuid)
clientId
string (uuid)
scopeFilters
Array of string
string
filtersConfiguration
object (FiltersConfiguration)
description
string
includeResourceLevelProperties
boolean
includeCharts
boolean
policies
Array of object (PolicyItem)
object
assignmentId
string
assignmentName
string
clientId
string (uuid)
subscriptionId
string (uuid)
policyStates
Array of string
string
ignorableCost
number
filterBy
Array of object (FilterByItem)
object
filterType
integer (int32)
servicePrincipal
object (FilterServicePrincipal)
clientId
string (uuid)
subscriptionId
string (uuid)
tenantId
string (uuid)
subscriptionName
string
filterValues
Array of string
string
tagKey
string
resourceType
string
accessTypes
Array of string
string
roleType
Array of string
string
recommendations
Array of string
string
reservationRecommendations
Array of string
string
carbonScopes
Array of string
string
documentFormat
integer (int32)
documentParameters
object (DocumentParameters)
selectedBillingDateRangeTypeName
string
selectedBillingDateRangeTypeName1
string
customDateRange1
integer (int32)
customDateRange2
integer (int32)
customFromDate
string
customToDate
string
customFromDate1
string
customToDate1
string
includeResourceGroup
boolean
accessDetailsGroupBy
integer (int32)
currencyType
integer (int32)
accessTypes
Array of integer
integer (int32)
selectedDiagramType
integer (int32)
carbonReportType
integer (int32)
carbonSummaryGroupBy
integer (int32)
office365ReportType
integer (int32)
styling
object (DocumentStyling)
accentColour
string
logoReference
string
logoFileName
string
Responses
200
Success