GradientEdge CDK Utils
    Preparing search index...

    Class AzureRestApi

    Provides a construct to create and deploy an Azure API Management service with diagnostics and logging

    import { AzureRestApi, AzureRestApiProps } from '@gradientedge/cdk-utils'

    class CustomConstruct extends AzureRestApi {
      constructor(id: string, props: AzureRestApiProps) {
        super(id, props)
        this.props = props
        this.id = id
        this.initResources()
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    api apiManagementManager appConfigurationManager applicationInsights applicationInsightsManager appServiceManager authorisationManager commonLogAnalyticsWorkspace cosmosDbManager dnsManager eventgridManager fullyQualifiedDomainName functionManager id keyVaultManager monitorManager operationalInsightsManager options? portalManager props redisManager resourceGroup resourceGroupManager resourceNameFormatter securityCentermanager serviceBusManager storageManager urn

    Methods

    createApiDiagnostic createApiManagement createApiManagementLogger createDiagnosticLog createNamespaceSecret createNamespaceSecretRole createResourceGroup createSubscriptionKeySecret determineFullyQualifiedDomain getData getProvider initialize initResources isDevelopmentStage isProductionStage isTestStage isUatStage registerOutputs resolveApiKeyVault resolveApplicationInsights resolveCommonLogAnalyticsWorkspace resolveStack isInstance

    Constructors

    Properties

    api: AzureApi = ...

    Provisioned API Management resources

    apiManagementManager: AzureApiManagementManager

    Manager for Azure API Management resources

    appConfigurationManager: AzureAppConfigurationManager

    Manager for Azure App Configuration resources

    applicationInsights: Output<GetComponentResult>

    The resolved Application Insights component for telemetry

    applicationInsightsManager: AzureApplicationInsightsManager

    Manager for Azure Application Insights resources

    appServiceManager: AzureAppServiceManager

    Manager for Azure App Service resources

    authorisationManager: AzureAuthorisationManager

    Manager for Azure RBAC role assignments

    commonLogAnalyticsWorkspace: Workspace | Output<GetWorkspaceResult>

    Shared Log Analytics Workspace resolved from props, used for diagnostic logging

    cosmosDbManager: AzureCosmosDbManager

    Manager for Azure CosmosDB resources

    dnsManager: AzureDnsManager

    Manager for Azure DNS resources

    eventgridManager: AzureEventgridManager

    Manager for Azure Event Grid resources

    fullyQualifiedDomainName: string

    The fully qualified domain name derived from domainName and subDomain

    functionManager: AzureFunctionManager

    Manager for Azure Function App resources

    id: string

    Unique identifier for the construct

    keyVaultManager: AzureKeyVaultManager

    Manager for Azure Key Vault resources

    monitorManager: AzureMonitorManager

    Manager for Azure Monitor diagnostic settings

    operationalInsightsManager: AzureOperationalInsightsManager

    Manager for Azure Log Analytics Workspace resources

    options?: ComponentResourceOptions

    Optional Pulumi component resource options

    portalManager: AzurePortalManager

    Manager for Azure Portal Dashboard resources

    props: AzureRestApiProps

    REST API properties

    redisManager: AzureRedisManager

    Manager for Azure Managed Redis (Enterprise) resources

    resourceGroup: ResourceGroup

    The Azure resource group associated with this construct

    resourceGroupManager: AzureResourceGroupManager

    Manager for Azure Resource Group resources

    resourceNameFormatter: AzureResourceNameFormatter

    Formatter for Azure resource names based on naming conventions

    securityCentermanager: AzureSecurityCentermanager

    Manager for Azure Security Center (Defender) resources

    serviceBusManager: AzureServiceBusManager

    Manager for Azure Service Bus resources

    storageManager: AzureStorageManager

    Manager for Azure Storage resources

    urn: Output<string>

    The stable logical URN used to distinctly address a resource, both before and after deployments.

    Methods

    • Retrieves the data produces by initialize. The data is immediately available in a derived class's constructor after the super(...) call to ComponentResource.

      Returns Promise<any>

    • Returns the provider for the given module member, if one exists.

      Parameters

      • moduleMember: string

      Returns ProviderResource | undefined

    • Can be overridden by a subclass to asynchronously initialize data for this component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use getData.

      Parameters

      • args: Inputs
      • Optionalopts: ComponentResourceOptions
      • Optionalname: string
      • Optionaltype: string

      Returns Promise<any>

    • Registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

      Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

      Parameters

      • Optionaloutputs: Inputs | Promise<Inputs> | Output<Inputs>

      Returns void

    • Returns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

      Parameters

      • obj: any

      Returns obj is ComponentResource<any>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods