Class AzureApiManagementManager

Provides operations on Azure API Management using Pulumi

A new instance of this class is injected into CommonAzureConstruct constructor.
If a custom construct extends CommonAzureConstruct, an instance is available within the context.

Example

import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'

class CustomConstruct extends CommonAzureConstruct {
  constructor(name: string, props: CommonAzureStackProps) {
    super(name, props)
    this.props = props
    this.apiManagementManager.createApiManagement('MyApiManagement', this, props)
  }
}

Index

Constructors

constructor

Methods

createApi createApiDiagnostic createApiManagementCustomDomain createApiManagementService createBackend createCache createLogger createNamedValue createOperation createOperationPolicy createPolicy createSubscription resolveApiManagementService

Constructors

constructor

new AzureApiManagementManager(): AzureApiManagementManager
Returns AzureApiManagementManager

Methods

createApi

createApi(
    id: string,
    scope: CommonAzureConstruct,
    props: ApiManagementApiProps,
    resourceOptions?: ResourceOptions,
): Api
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: ApiManagementApiProps
  API Management API properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Api
See
[Pulumi Azure Native API Management API]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/api/
- Defined in packages/azure/src/services/api-management/main.ts:217

createApiDiagnostic

createApiDiagnostic(
    id: string,
    scope: CommonAzureConstruct,
    props: ApiDiagnosticProps,
    resourceOptions?: ResourceOptions,
): ApiDiagnostic
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: ApiDiagnosticProps
  API Disagnostic properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns ApiDiagnostic
See
[Pulumi Azure Native API Management Diagnostic]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/apidiagnostic/
- Defined in packages/azure/src/services/api-management/main.ts:251

createApiManagementCustomDomain

createApiManagementCustomDomain(): void
Returns void
- Defined in packages/azure/src/services/api-management/main.ts:384

createApiManagementService

createApiManagementService(
    id: string,
    scope: CommonAzureConstruct,
    props: ApiManagementProps,
    applicationInsightsKey?: string,
    externalRedisCache?: Redis,
    resourceOptions?: ResourceOptions,
): ApiManagementService
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: ApiManagementProps
  API Management properties
- OptionalapplicationInsightsKey: string
  Optional Application Insights instrumentation key for logging
- OptionalexternalRedisCache: Redis
  Optional external Redis cache for API Management caching
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns ApiManagementService
See
[Pulumi Azure Native API Management]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/apimanagementservice/
- Defined in packages/azure/src/services/api-management/main.ts:67

createBackend

createBackend(
    id: string,
    scope: CommonAzureConstruct,
    props: ApiManagementBackendProps,
    resourceOptions?: ResourceOptions,
): Backend
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: ApiManagementBackendProps
  API Management backend properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Backend
See
[Pulumi Azure Native API Management Backend]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/backend/
- Defined in packages/azure/src/services/api-management/main.ts:186

createCache

createCache(
    id: string,
    scope: CommonAzureConstruct,
    props: CacheProps,
    resourceOptions?: ResourceOptions,
): Cache
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: CacheProps
  API cache properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Cache
See
[Pulumi Azure Native API Management Cache]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/cache/
- Defined in packages/azure/src/services/api-management/main.ts:322

createLogger

createLogger(
    id: string,
    scope: CommonAzureConstruct,
    props: LoggerProps,
    resourceOptions?: ResourceOptions,
): Logger
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: LoggerProps
  API Logger properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Logger
See
[Pulumi Azure Native API Management Logger]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/logger/
- Defined in packages/azure/src/services/api-management/main.ts:270

createNamedValue

createNamedValue(
    id: string,
    scope: CommonAzureConstruct,
    props: NamedValueProps,
    resourceOptions?: ResourceOptions,
): NamedValue
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: NamedValueProps
  API Named Value properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns NamedValue
See
[Pulumi Azure Native API Management Named Value]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/namedvalue/
- Defined in packages/azure/src/services/api-management/main.ts:284

createOperation

createOperation(
    id: string,
    scope: CommonAzureConstruct,
    props: ApiOperationProps,
    resourceOptions?: ResourceOptions,
): ApiOperation
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: ApiOperationProps
  API operation properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns ApiOperation
See
[Pulumi Azure Native API Management Operation]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/apioperation/
- Defined in packages/azure/src/services/api-management/main.ts:336

createOperationPolicy

createOperationPolicy(
    id: string,
    scope: CommonAzureConstruct,
    props: ApiOperationPolicyProps,
    resourceOptions?: ResourceOptions,
): ApiOperationPolicy
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: ApiOperationPolicyProps
  API operation policy properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns ApiOperationPolicy
See
[Pulumi Azure Native API Management Operation Policy]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/apioperationpolicy/
- Defined in packages/azure/src/services/api-management/main.ts:353

createPolicy

createPolicy(
    id: string,
    scope: CommonAzureConstruct,
    props: ApiPolicyProps,
    resourceOptions?: ResourceOptions,
): ApiPolicy
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: ApiPolicyProps
  API policy properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns ApiPolicy
See
[Pulumi Azure Native API Management Policy]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/apipolicy/
- Defined in packages/azure/src/services/api-management/main.ts:370

createSubscription

createSubscription(
    id: string,
    scope: CommonAzureConstruct,
    props: ApiSubscriptionProps,
    resourceOptions?: ResourceOptions,
): Subscription
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: ApiSubscriptionProps
  API Subscription properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Subscription
See
[Pulumi Azure Native API Management Subscription]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/subscription/
- Defined in packages/azure/src/services/api-management/main.ts:303

resolveApiManagementService

resolveApiManagementService(
    id: string,
    scope: CommonAzureConstruct,
    props: ResolveApiManagementProps,
    resourceOptions?: ResourceOptions,
): Output<GetApiManagementServiceResult>
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: ResolveApiManagementProps
  API Management lookup properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Output<GetApiManagementServiceResult>
See
[Pulumi Azure Native API Management Lookup]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/apimanagementservice/
- Defined in packages/azure/src/services/api-management/main.ts:156

Class AzureApiManagementManager

Example

Index

Constructors

Methods

Constructors

constructor

Returns AzureApiManagementManager

Methods

createApi

Parameters

Returns Api

See

createApiDiagnostic

Parameters

Returns ApiDiagnostic

See

createApiManagementCustomDomain

Returns void

createApiManagementService

Parameters

Returns ApiManagementService

See

createBackend

Parameters

Returns Backend

See

createCache

Parameters

Returns Cache

See

createLogger

Parameters

Returns Logger

See

createNamedValue

Parameters

Returns NamedValue

See

createOperation

Parameters

Returns ApiOperation

See

createOperationPolicy

Parameters

Returns ApiOperationPolicy

See

createPolicy

Parameters

Returns ApiPolicy

See

createSubscription

Parameters

Returns Subscription

See

resolveApiManagementService

Parameters

Returns Output<GetApiManagementServiceResult>

See

Settings

On This Page