Fork me on GitHub

Module apimanagement

@pulumi/azure > apimanagement

Index

apimanagement/aPI.ts apimanagement/getAPI.ts

class API

Manages an API Management Service.

constructor

new API(name: string, args: APIArgs, opts?: pulumi.CustomResourceOptions)

Create a API resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: APIState): API

Get an existing API resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

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

property additionalLocation

public additionalLocation: pulumi.Output<{ ... } | undefined>;

One or more additional_location blocks as defined below.

property certificates

public certificates: pulumi.Output<{ ... }[] | undefined>;

One or more (up to 10) certificate blocks as defined below.

property gatewayRegionalUrl

public gatewayRegionalUrl: pulumi.Output<string>;

The URL of the Regional Gateway for the API Management Service in the specified region.

property gatewayUrl

public gatewayUrl: pulumi.Output<string>;

The URL of the Gateway for the API Management Service.

property hostnameConfiguration

public hostnameConfiguration: pulumi.Output<{ ... }>;

A hostname_configuration block as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<{ ... } | undefined>;

An identity block is documented below.

property location

public location: pulumi.Output<string>;

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

property managementApiUrl

public managementApiUrl: pulumi.Output<string>;

The URL for the Management API associated with this API Management service.

property name

public name: pulumi.Output<string>;

The name of the API Management Service. Changing this forces a new resource to be created.

property notificationSenderEmail

public notificationSenderEmail: pulumi.Output<string>;

Email address from which the notification will be sent.

property portalUrl

public portalUrl: pulumi.Output<string>;

The URL for the Publisher Portal associated with this API Management service.

property publisherEmail

public publisherEmail: pulumi.Output<string>;

The email of publisher/company.

property publisherName

public publisherName: pulumi.Output<string>;

The name of publisher/company.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

property scmUrl

public scmUrl: pulumi.Output<string>;

The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

property security

public security: pulumi.Output<{ ... }>;

A security block as defined below.

property sku

public sku: pulumi.Output<{ ... }>;

A sku block as documented below.

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags assigned to the resource.

property urn

urn: Output<URN>;

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

function getAPI

getAPI(args: GetAPIArgs, opts?: pulumi.InvokeOptions): Promise<GetAPIResult>

Use this data source to access information about an existing API Management Service.

interface APIArgs

The set of arguments for constructing a API resource.

property additionalLocation

additionalLocation?: pulumi.Input<{ ... }>;

One or more additional_location blocks as defined below.

property certificates

certificates?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more (up to 10) certificate blocks as defined below.

property hostnameConfiguration

hostnameConfiguration?: pulumi.Input<{ ... }>;

A hostname_configuration block as defined below.

property identity

identity?: pulumi.Input<{ ... }>;

An identity block is documented below.

property location

location: pulumi.Input<string>;

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the API Management Service. Changing this forces a new resource to be created.

property notificationSenderEmail

notificationSenderEmail?: pulumi.Input<string>;

Email address from which the notification will be sent.

property publisherEmail

publisherEmail: pulumi.Input<string>;

The email of publisher/company.

property publisherName

publisherName: pulumi.Input<string>;

The name of publisher/company.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

property security

security?: pulumi.Input<{ ... }>;

A security block as defined below.

property sku

sku: pulumi.Input<{ ... }>;

A sku block as documented below.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags assigned to the resource.

interface APIState

Input properties used for looking up and filtering API resources.

property additionalLocation

additionalLocation?: pulumi.Input<{ ... }>;

One or more additional_location blocks as defined below.

property certificates

certificates?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more (up to 10) certificate blocks as defined below.

property gatewayRegionalUrl

gatewayRegionalUrl?: pulumi.Input<string>;

The URL of the Regional Gateway for the API Management Service in the specified region.

property gatewayUrl

gatewayUrl?: pulumi.Input<string>;

The URL of the Gateway for the API Management Service.

property hostnameConfiguration

hostnameConfiguration?: pulumi.Input<{ ... }>;

A hostname_configuration block as defined below.

property identity

identity?: pulumi.Input<{ ... }>;

An identity block is documented below.

property location

location?: pulumi.Input<string>;

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

property managementApiUrl

managementApiUrl?: pulumi.Input<string>;

The URL for the Management API associated with this API Management service.

property name

name?: pulumi.Input<string>;

The name of the API Management Service. Changing this forces a new resource to be created.

property notificationSenderEmail

notificationSenderEmail?: pulumi.Input<string>;

Email address from which the notification will be sent.

property portalUrl

portalUrl?: pulumi.Input<string>;

The URL for the Publisher Portal associated with this API Management service.

property publisherEmail

publisherEmail?: pulumi.Input<string>;

The email of publisher/company.

property publisherName

publisherName?: pulumi.Input<string>;

The name of publisher/company.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

property scmUrl

scmUrl?: pulumi.Input<string>;

The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

property security

security?: pulumi.Input<{ ... }>;

A security block as defined below.

property sku

sku?: pulumi.Input<{ ... }>;

A sku block as documented below.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags assigned to the resource.

interface GetAPIArgs

A collection of arguments for invoking getAPI.

property name

name: string;

The name of the API Management service.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group in which the API Management Service exists.

interface GetAPIResult

A collection of values returned by getAPI.

property additionalLocations

additionalLocations: { ... }[];

One or more additional_location blocks as defined below

property gatewayRegionalUrl

gatewayRegionalUrl: string;

Gateway URL of the API Management service in the Region.

property gatewayUrl

gatewayUrl: string;

The URL for the API Management Service’s Gateway.

property hostnameConfigurations

hostnameConfigurations: { ... }[];

A hostname_configuration block as defined below.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property location

location: string;

The location name of the additional region among Azure Data center regions.

property managementApiUrl

managementApiUrl: string;

The URL for the Management API.

property notificationSenderEmail

notificationSenderEmail: string;

The email address from which the notification will be sent.

property portalUrl

portalUrl: string;

The URL of the Publisher Portal.

property publisherEmail

publisherEmail: string;

The email of Publisher/Company of the API Management Service.

property publisherName

publisherName: string;

The name of the Publisher/Company of the API Management Service.

property scmUrl

scmUrl: string;

The SCM (Source Code Management) endpoint.

property sku

sku: { ... };

A sku block as documented below.

property tags

tags: { ... };

A mapping of tags assigned to the resource.