Contents x
    Create a new document configuration
    • 12 Mar 2024
    • 3 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Create a new document configuration

    • Updated on 12 Mar 2024
    • 3 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Post
    /AzureDocumenter/AddDocumentConfiguration
    Security
    API Key
    Header parameter nameAPIKey

    API key which has access for your API

    Body parameters
    Expand All
    object
    name
    string Required
    Min length1
    description
    string
    isAddNewServicePrincipal
    boolean Required
    servicePrincipalDetails
    object (ServicePrincipalDetailsAD)
    friendlyName
    string Required
    Min length1
    tenantId
    string (uuid) Required
    clientId
    string (uuid) Required
    clientSecret
    string Required
    Min length1
    clientSecretExpirationDate
    string (date-time) Required
    platformId
    string (uuid) Required
    projectName
    string
    accessToken
    string
    publishType
    integer (int32) Required
    Valid values[ 1, 2 ]
    connectionString
    string
    selectedNotificationChannels
    Array of string
    string (uuid)
    isNotification
    boolean Required
    recipientEmailAddress
    string
    recipientTemplateId
    string (uuid)
    channelTemplateMapping
    Array of object (ChannelTemplateMapping)
    object
    configuredChannelId
    string (uuid)
    customMailTemplateId
    string (uuid)
    emailSubject
    string
    documentType
    integer (int32) Required
    fromDate1
    string
    toDate1
    string
    fromDate2
    string
    toDate2
    string
    selectedSubscriptions
    Array of object (SelectedPairsModel) Required
    object
    subscriptionId
    string (uuid)
    clientId
    string (uuid)
    filtersConfiguration
    object (FilterConfigurationStructure)
    description
    string
    includeResourceLevelProperties
    boolean
    includeCharts
    boolean
    policies
    Array of object (PolicyDetail)
    object
    assignmentId
    string
    assignmentName
    string
    clientId
    string (uuid)
    subscriptionId
    string (uuid)
    policyStates
    Array of string
    string
    ignorableCost
    integer (int32)
    filterBy
    Array of object (FilterBy)
    object
    filterType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    servicePrincipal
    object (ServicePrincipalForFilter)
    clientId
    string (uuid)
    subscriptionId
    string (uuid)
    tenantId
    string (uuid)
    subscriptionName
    string
    filterValues
    Array of string
    string
    tagKey
    string
    valueOptions
    Array of string
    string
    resourceStates
    Array of string
    string
    accessTypes
    Array of string
    string
    roleType
    Array of string
    string
    recommendations
    Array of string
    string
    reservationRecommendations
    Array of string
    string
    documentFormat
    integer (int32) Required
    Valid values[ 1, 2 ]
    accessDetailsGroupBy
    integer (int32)
    includeResourceGroup
    boolean
    currencyType
    integer (int32)
    accessTypes
    Array of integer
    integer (int32)
    Expand All
    object
    name
    string Required
    Min length1
    description
    string
    isAddNewServicePrincipal
    boolean Required
    servicePrincipalDetails
    object (ServicePrincipalDetailsAD)
    friendlyName
    string Required
    Min length1
    tenantId
    string (uuid) Required
    clientId
    string (uuid) Required
    clientSecret
    string Required
    Min length1
    clientSecretExpirationDate
    string (date-time) Required
    platformId
    string (uuid) Required
    projectName
    string
    accessToken
    string
    publishType
    integer (int32) Required
    Valid values[ 1, 2 ]
    connectionString
    string
    selectedNotificationChannels
    Array of string
    string (uuid)
    isNotification
    boolean Required
    recipientEmailAddress
    string
    recipientTemplateId
    string (uuid)
    channelTemplateMapping
    Array of object (ChannelTemplateMapping)
    object
    configuredChannelId
    string (uuid)
    customMailTemplateId
    string (uuid)
    emailSubject
    string
    documentType
    integer (int32) Required
    fromDate1
    string
    toDate1
    string
    fromDate2
    string
    toDate2
    string
    selectedSubscriptions
    Array of object (SelectedPairsModel) Required
    object
    subscriptionId
    string (uuid)
    clientId
    string (uuid)
    filtersConfiguration
    object (FilterConfigurationStructure)
    description
    string
    includeResourceLevelProperties
    boolean
    includeCharts
    boolean
    policies
    Array of object (PolicyDetail)
    object
    assignmentId
    string
    assignmentName
    string
    clientId
    string (uuid)
    subscriptionId
    string (uuid)
    policyStates
    Array of string
    string
    ignorableCost
    integer (int32)
    filterBy
    Array of object (FilterBy)
    object
    filterType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    servicePrincipal
    object (ServicePrincipalForFilter)
    clientId
    string (uuid)
    subscriptionId
    string (uuid)
    tenantId
    string (uuid)
    subscriptionName
    string
    filterValues
    Array of string
    string
    tagKey
    string
    valueOptions
    Array of string
    string
    resourceStates
    Array of string
    string
    accessTypes
    Array of string
    string
    roleType
    Array of string
    string
    recommendations
    Array of string
    string
    reservationRecommendations
    Array of string
    string
    documentFormat
    integer (int32) Required
    Valid values[ 1, 2 ]
    accessDetailsGroupBy
    integer (int32)
    includeResourceGroup
    boolean
    currencyType
    integer (int32)
    accessTypes
    Array of integer
    integer (int32)
    Expand All
    object
    name
    string Required
    Min length1
    description
    string
    isAddNewServicePrincipal
    boolean Required
    servicePrincipalDetails
    object (ServicePrincipalDetailsAD)
    friendlyName
    string Required
    Min length1
    tenantId
    string (uuid) Required
    clientId
    string (uuid) Required
    clientSecret
    string Required
    Min length1
    clientSecretExpirationDate
    string (date-time) Required
    platformId
    string (uuid) Required
    projectName
    string
    accessToken
    string
    publishType
    integer (int32) Required
    Valid values[ 1, 2 ]
    connectionString
    string
    selectedNotificationChannels
    Array of string
    string (uuid)
    isNotification
    boolean Required
    recipientEmailAddress
    string
    recipientTemplateId
    string (uuid)
    channelTemplateMapping
    Array of object (ChannelTemplateMapping)
    object
    configuredChannelId
    string (uuid)
    customMailTemplateId
    string (uuid)
    emailSubject
    string
    documentType
    integer (int32) Required
    fromDate1
    string
    toDate1
    string
    fromDate2
    string
    toDate2
    string
    selectedSubscriptions
    Array of object (SelectedPairsModel) Required
    object
    subscriptionId
    string (uuid)
    clientId
    string (uuid)
    filtersConfiguration
    object (FilterConfigurationStructure)
    description
    string
    includeResourceLevelProperties
    boolean
    includeCharts
    boolean
    policies
    Array of object (PolicyDetail)
    object
    assignmentId
    string
    assignmentName
    string
    clientId
    string (uuid)
    subscriptionId
    string (uuid)
    policyStates
    Array of string
    string
    ignorableCost
    integer (int32)
    filterBy
    Array of object (FilterBy)
    object
    filterType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    servicePrincipal
    object (ServicePrincipalForFilter)
    clientId
    string (uuid)
    subscriptionId
    string (uuid)
    tenantId
    string (uuid)
    subscriptionName
    string
    filterValues
    Array of string
    string
    tagKey
    string
    valueOptions
    Array of string
    string
    resourceStates
    Array of string
    string
    accessTypes
    Array of string
    string
    roleType
    Array of string
    string
    recommendations
    Array of string
    string
    reservationRecommendations
    Array of string
    string
    documentFormat
    integer (int32) Required
    Valid values[ 1, 2 ]
    accessDetailsGroupBy
    integer (int32)
    includeResourceGroup
    boolean
    currencyType
    integer (int32)
    accessTypes
    Array of integer
    integer (int32)
    Expand All
    object
    name
    string Required
    Min length1
    description
    string
    isAddNewServicePrincipal
    boolean Required
    servicePrincipalDetails
    object (ServicePrincipalDetailsAD)
    friendlyName
    string Required
    Min length1
    tenantId
    string (uuid) Required
    clientId
    string (uuid) Required
    clientSecret
    string Required
    Min length1
    clientSecretExpirationDate
    string (date-time) Required
    platformId
    string (uuid) Required
    projectName
    string
    accessToken
    string
    publishType
    integer (int32) Required
    Valid values[ 1, 2 ]
    connectionString
    string
    selectedNotificationChannels
    Array of string
    string (uuid)
    isNotification
    boolean Required
    recipientEmailAddress
    string
    recipientTemplateId
    string (uuid)
    channelTemplateMapping
    Array of object (ChannelTemplateMapping)
    object
    configuredChannelId
    string (uuid)
    customMailTemplateId
    string (uuid)
    emailSubject
    string
    documentType
    integer (int32) Required
    fromDate1
    string
    toDate1
    string
    fromDate2
    string
    toDate2
    string
    selectedSubscriptions
    Array of object (SelectedPairsModel) Required
    object
    subscriptionId
    string (uuid)
    clientId
    string (uuid)
    filtersConfiguration
    object (FilterConfigurationStructure)
    description
    string
    includeResourceLevelProperties
    boolean
    includeCharts
    boolean
    policies
    Array of object (PolicyDetail)
    object
    assignmentId
    string
    assignmentName
    string
    clientId
    string (uuid)
    subscriptionId
    string (uuid)
    policyStates
    Array of string
    string
    ignorableCost
    integer (int32)
    filterBy
    Array of object (FilterBy)
    object
    filterType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    servicePrincipal
    object (ServicePrincipalForFilter)
    clientId
    string (uuid)
    subscriptionId
    string (uuid)
    tenantId
    string (uuid)
    subscriptionName
    string
    filterValues
    Array of string
    string
    tagKey
    string
    valueOptions
    Array of string
    string
    resourceStates
    Array of string
    string
    accessTypes
    Array of string
    string
    roleType
    Array of string
    string
    recommendations
    Array of string
    string
    reservationRecommendations
    Array of string
    string
    documentFormat
    integer (int32) Required
    Valid values[ 1, 2 ]
    accessDetailsGroupBy
    integer (int32)
    includeResourceGroup
    boolean
    currencyType
    integer (int32)
    accessTypes
    Array of integer
    integer (int32)
    Responses
    200

    Success

    Was this article helpful?
    What's Next