apimanagement

Documentation

Index

• type API
  • func GetAPI(ctx *pulumi.Context, name string, id pulumi.ID, state *APIState, ...) (*API, error)
  • func NewAPI(ctx *pulumi.Context, name string, args *APIArgs, opts ...pulumi.ResourceOpt) (*API, error)
  • func (r *API) AdditionalLocation() *pulumi.Output
  • func (r *API) Certificates() *pulumi.ArrayOutput
  • func (r *API) GatewayRegionalUrl() *pulumi.StringOutput
  • func (r *API) GatewayUrl() *pulumi.StringOutput
  • func (r *API) HostnameConfiguration() *pulumi.Output
  • func (r *API) ID() *pulumi.IDOutput
  • func (r *API) Identity() *pulumi.Output
  • func (r *API) Location() *pulumi.StringOutput
  • func (r *API) ManagementApiUrl() *pulumi.StringOutput
  • func (r *API) Name() *pulumi.StringOutput
  • func (r *API) NotificationSenderEmail() *pulumi.StringOutput
  • func (r *API) PortalUrl() *pulumi.StringOutput
  • func (r *API) PublicIpAddresses() *pulumi.ArrayOutput
  • func (r *API) PublisherEmail() *pulumi.StringOutput
  • func (r *API) PublisherName() *pulumi.StringOutput
  • func (r *API) ResourceGroupName() *pulumi.StringOutput
  • func (r *API) ScmUrl() *pulumi.StringOutput
  • func (r *API) Security() *pulumi.Output
  • func (r *API) Sku() *pulumi.Output
  • func (r *API) Tags() *pulumi.MapOutput
  • func (r *API) URN() *pulumi.URNOutput
• type APIArgs
• type APIState
• type GetAPIArgs
• type GetAPIResult
  • func LookupAPI(ctx *pulumi.Context, args *GetAPIArgs) (*GetAPIResult, error)

Types

type API

type API struct {
	// contains filtered or unexported fields
}

Manages an API Management Service.

func GetAPI

func GetAPI(ctx *pulumi.Context,
	name string, id pulumi.ID, state *APIState, opts ...pulumi.ResourceOpt) (*API, error)

GetAPI gets an existing API resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAPI

func NewAPI(ctx *pulumi.Context,
	name string, args *APIArgs, opts ...pulumi.ResourceOpt) (*API, error)

NewAPI registers a new resource with the given unique name, arguments, and options.

func (*API) AdditionalLocation

func (r *API) AdditionalLocation() *pulumi.Output

One or more `additional_location` blocks as defined below.

func (*API) Certificates

func (r *API) Certificates() *pulumi.ArrayOutput

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

func (*API) GatewayRegionalUrl

func (r *API) GatewayRegionalUrl() *pulumi.StringOutput

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

func (*API) GatewayUrl

func (r *API) GatewayUrl() *pulumi.StringOutput

The URL of the Gateway for the API Management Service.

func (*API) HostnameConfiguration

func (r *API) HostnameConfiguration() *pulumi.Output

A `hostname_configuration` block as defined below.

func (*API) ID

func (r *API) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*API) Identity

func (r *API) Identity() *pulumi.Output

An `identity` block is documented below.

func (*API) Location

func (r *API) Location() *pulumi.StringOutput

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

func (*API) ManagementApiUrl

func (r *API) ManagementApiUrl() *pulumi.StringOutput

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

func (*API) Name

func (r *API) Name() *pulumi.StringOutput

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

func (*API) NotificationSenderEmail

func (r *API) NotificationSenderEmail() *pulumi.StringOutput

Email address from which the notification will be sent.

func (*API) PortalUrl

func (r *API) PortalUrl() *pulumi.StringOutput

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

func (*API) PublicIpAddresses

func (r *API) PublicIpAddresses() *pulumi.ArrayOutput

Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.

func (*API) PublisherEmail

func (r *API) PublisherEmail() *pulumi.StringOutput

The email of publisher/company.

func (*API) PublisherName

func (r *API) PublisherName() *pulumi.StringOutput

The name of publisher/company.

func (*API) ResourceGroupName

func (r *API) ResourceGroupName() *pulumi.StringOutput

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

func (*API) ScmUrl

func (r *API) ScmUrl() *pulumi.StringOutput

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

func (*API) Security

func (r *API) Security() *pulumi.Output

A `security` block as defined below.

func (*API) Sku

func (r *API) Sku() *pulumi.Output

A `sku` block as documented below.

func (*API) Tags

func (r *API) Tags() *pulumi.MapOutput

A mapping of tags assigned to the resource.

func (*API) URN

func (r *API) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type APIArgs

type APIArgs struct {
	// One or more `additional_location` blocks as defined below.
	AdditionalLocation interface{}
	// One or more (up to 10) `certificate` blocks as defined below.
	Certificates interface{}
	// A `hostname_configuration` block as defined below.
	HostnameConfiguration interface{}
	// An `identity` block is documented below.
	Identity interface{}
	// The Azure location where the API Management Service exists. Changing this forces a new resource to be created.
	Location interface{}
	// The name of the API Management Service. Changing this forces a new resource to be created.
	Name interface{}
	// Email address from which the notification will be sent.
	NotificationSenderEmail interface{}
	// The email of publisher/company.
	PublisherEmail interface{}
	// The name of publisher/company.
	PublisherName interface{}
	// The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// A `security` block as defined below.
	Security interface{}
	// A `sku` block as documented below.
	Sku interface{}
	// A mapping of tags assigned to the resource.
	Tags interface{}
}

The set of arguments for constructing a API resource.

type APIState

type APIState struct {
	// One or more `additional_location` blocks as defined below.
	AdditionalLocation interface{}
	// One or more (up to 10) `certificate` blocks as defined below.
	Certificates interface{}
	// The URL of the Regional Gateway for the API Management Service in the specified region.
	GatewayRegionalUrl interface{}
	// The URL of the Gateway for the API Management Service.
	GatewayUrl interface{}
	// A `hostname_configuration` block as defined below.
	HostnameConfiguration interface{}
	// An `identity` block is documented below.
	Identity interface{}
	// The Azure location where the API Management Service exists. Changing this forces a new resource to be created.
	Location interface{}
	// The URL for the Management API associated with this API Management service.
	ManagementApiUrl interface{}
	// The name of the API Management Service. Changing this forces a new resource to be created.
	Name interface{}
	// Email address from which the notification will be sent.
	NotificationSenderEmail interface{}
	// The URL for the Publisher Portal associated with this API Management service.
	PortalUrl interface{}
	// Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.
	PublicIpAddresses interface{}
	// The email of publisher/company.
	PublisherEmail interface{}
	// The name of publisher/company.
	PublisherName interface{}
	// The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.
	ScmUrl interface{}
	// A `security` block as defined below.
	Security interface{}
	// A `sku` block as documented below.
	Sku interface{}
	// A mapping of tags assigned to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering API resources.

type GetAPIArgs

type GetAPIArgs struct {
	// The name of the API Management service.
	Name interface{}
	// The Name of the Resource Group in which the API Management Service exists.
	ResourceGroupName interface{}
}

A collection of arguments for invoking getAPI.

type GetAPIResult

type GetAPIResult struct {
	// One or more `additional_location` blocks as defined below
	AdditionalLocations interface{}
	// Gateway URL of the API Management service in the Region.
	GatewayRegionalUrl interface{}
	// The URL for the API Management Service's Gateway.
	GatewayUrl interface{}
	// A `hostname_configuration` block as defined below.
	HostnameConfigurations interface{}
	// The location name of the additional region among Azure Data center regions.
	Location interface{}
	// The URL for the Management API.
	ManagementApiUrl interface{}
	// The email address from which the notification will be sent.
	NotificationSenderEmail interface{}
	// The URL of the Publisher Portal.
	PortalUrl interface{}
	// Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.
	PublicIpAddresses interface{}
	// The email of Publisher/Company of the API Management Service.
	PublisherEmail interface{}
	// The name of the Publisher/Company of the API Management Service.
	PublisherName interface{}
	// The SCM (Source Code Management) endpoint.
	ScmUrl interface{}
	// A `sku` block as documented below.
	Sku interface{}
	// A mapping of tags assigned to the resource.
	Tags interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getAPI.

func LookupAPI

func LookupAPI(ctx *pulumi.Context, args *GetAPIArgs) (*GetAPIResult, error)

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