apimanagement

package
v0.17.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 19, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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 added in v0.16.5 

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.

type GetGroupArgs added in v0.17.2 

type GetGroupArgs struct {
	// The Name of the API Management Service in which this Group exists.
	ApiManagementName interface{}
	// The Name of the API Management Group.
	Name interface{}
	// The Name of the Resource Group in which the API Management Service exists.
	ResourceGroupName interface{}
}

A collection of arguments for invoking getGroup.

type GetGroupResult added in v0.17.2 

type GetGroupResult struct {
	// The description of this API Management Group.
	Description interface{}
	// The display name of this API Management Group.
	DisplayName interface{}
	// The identifier of the external Group.
	ExternalId interface{}
	// The type of this API Management Group, such as `custom` or `external`.
	Type interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getGroup.

func LookupGroup added in v0.17.2 

func LookupGroup(ctx *pulumi.Context, args *GetGroupArgs) (*GetGroupResult, error)

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

type GetProductArgs added in v0.17.2 

type GetProductArgs struct {
	// The Name of the API Management Service in which this Product exists.
	ApiManagementName interface{}
	// The Identifier for the API Management Product.
	ProductId interface{}
	// The Name of the Resource Group in which the API Management Service exists.
	ResourceGroupName interface{}
}

A collection of arguments for invoking getProduct.

type GetProductResult added in v0.17.2 

type GetProductResult struct {
	// Do subscribers need to be approved prior to being able to use the Product?
	ApprovalRequired interface{}
	// The description of this Product, which may include HTML formatting tags.
	Description interface{}
	// The Display Name for this API Management Product.
	DisplayName interface{}
	// Is this Product Published?
	Published interface{}
	// Is a Subscription required to access API's included in this Product?
	SubscriptionRequired interface{}
	// The number of subscriptions a user can have to this Product at the same time.
	SubscriptionsLimit interface{}
	// Any Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
	Terms interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getProduct.

func LookupProduct added in v0.17.2 

func LookupProduct(ctx *pulumi.Context, args *GetProductArgs) (*GetProductResult, error)

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

type GetUserArgs added in v0.17.2 

type GetUserArgs struct {
	// The Name of the API Management Service in which this User exists.
	ApiManagementName interface{}
	// The Name of the Resource Group in which the API Management Service exists.
	ResourceGroupName interface{}
	// The Identifier for the User.
	UserId interface{}
}

A collection of arguments for invoking getUser.

type GetUserResult added in v0.17.2 

type GetUserResult struct {
	// The Email Address used for this User.
	Email interface{}
	// The First Name for the User.
	FirstName interface{}
	// The Last Name for the User.
	LastName interface{}
	// Any notes about this User.
	Note interface{}
	// The current state of this User, for example `active`, `blocked` or `pending`.
	State interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getUser.

func LookupUser added in v0.17.2 

func LookupUser(ctx *pulumi.Context, args *GetUserArgs) (*GetUserResult, error)

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

type Group added in v0.17.2 

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

Manages an API Management Group.

func GetGroup added in v0.17.2 

func GetGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *GroupState, opts ...pulumi.ResourceOpt) (*Group, error)

GetGroup gets an existing Group 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 NewGroup added in v0.17.2 

func NewGroup(ctx *pulumi.Context,
	name string, args *GroupArgs, opts ...pulumi.ResourceOpt) (*Group, error)

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

func (*Group) ApiManagementName added in v0.17.2 

func (r *Group) ApiManagementName() *pulumi.StringOutput

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

func (*Group) Description added in v0.17.2 

func (r *Group) Description() *pulumi.StringOutput

The description of this API Management Group.

func (*Group) DisplayName added in v0.17.2 

func (r *Group) DisplayName() *pulumi.StringOutput

The display name of this API Management Group.

func (*Group) ExternalId added in v0.17.2 

func (r *Group) ExternalId() *pulumi.StringOutput

The identifier of the external Group. For example, an Azure Active Directory group `aad://<tenant>.onmicrosoft.com/groups/<group object id>`.

func (*Group) ID added in v0.17.2 

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

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

func (*Group) Name added in v0.17.2 

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

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

func (*Group) ResourceGroupName added in v0.17.2 

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

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

func (*Group) Type added in v0.17.2 

func (r *Group) Type() *pulumi.StringOutput

The type of this API Management Group. Possible values are `custom` and `external`. Default is `custom`.

func (*Group) URN added in v0.17.2 

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

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

type GroupArgs added in v0.17.2 

type GroupArgs struct {
	// The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The description of this API Management Group.
	Description interface{}
	// The display name of this API Management Group.
	DisplayName interface{}
	// The identifier of the external Group. For example, an Azure Active Directory group `aad://<tenant>.onmicrosoft.com/groups/<group object id>`.
	ExternalId interface{}
	// The name of the API Management Group. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The type of this API Management Group. Possible values are `custom` and `external`. Default is `custom`.
	Type interface{}
}

The set of arguments for constructing a Group resource.

type GroupState added in v0.17.2 

type GroupState struct {
	// The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The description of this API Management Group.
	Description interface{}
	// The display name of this API Management Group.
	DisplayName interface{}
	// The identifier of the external Group. For example, an Azure Active Directory group `aad://<tenant>.onmicrosoft.com/groups/<group object id>`.
	ExternalId interface{}
	// The name of the API Management Group. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The type of this API Management Group. Possible values are `custom` and `external`. Default is `custom`.
	Type interface{}
}

Input properties used for looking up and filtering Group resources.

type GroupUser added in v0.17.2 

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

Manages an API Management User Assignment to a Group.

func GetGroupUser added in v0.17.2 

func GetGroupUser(ctx *pulumi.Context,
	name string, id pulumi.ID, state *GroupUserState, opts ...pulumi.ResourceOpt) (*GroupUser, error)

GetGroupUser gets an existing GroupUser 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 NewGroupUser added in v0.17.2 

func NewGroupUser(ctx *pulumi.Context,
	name string, args *GroupUserArgs, opts ...pulumi.ResourceOpt) (*GroupUser, error)

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

func (*GroupUser) ApiManagementName added in v0.17.2 

func (r *GroupUser) ApiManagementName() *pulumi.StringOutput

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

func (*GroupUser) GroupName added in v0.17.2 

func (r *GroupUser) GroupName() *pulumi.StringOutput

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

func (*GroupUser) ID added in v0.17.2 

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

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

func (*GroupUser) ResourceGroupName added in v0.17.2 

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

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

func (*GroupUser) URN added in v0.17.2 

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

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

func (*GroupUser) UserId added in v0.17.2 

func (r *GroupUser) UserId() *pulumi.StringOutput

The ID of the API Management User which should be assigned to this API Management Group. Changing this forces a new resource to be created.

type GroupUserArgs added in v0.17.2 

type GroupUserArgs struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The Name of the API Management Group within the API Management Service. Changing this forces a new resource to be created.
	GroupName interface{}
	// The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The ID of the API Management User which should be assigned to this API Management Group. Changing this forces a new resource to be created.
	UserId interface{}
}

The set of arguments for constructing a GroupUser resource.

type GroupUserState added in v0.17.2 

type GroupUserState struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The Name of the API Management Group within the API Management Service. Changing this forces a new resource to be created.
	GroupName interface{}
	// The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The ID of the API Management User which should be assigned to this API Management Group. Changing this forces a new resource to be created.
	UserId interface{}
}

Input properties used for looking up and filtering GroupUser resources.

type Product added in v0.17.2 

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

Manages an API Management Product.

func GetProduct added in v0.17.2 

func GetProduct(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ProductState, opts ...pulumi.ResourceOpt) (*Product, error)

GetProduct gets an existing Product 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 NewProduct added in v0.17.2 

func NewProduct(ctx *pulumi.Context,
	name string, args *ProductArgs, opts ...pulumi.ResourceOpt) (*Product, error)

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

func (*Product) ApiManagementName added in v0.17.2 

func (r *Product) ApiManagementName() *pulumi.StringOutput

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

func (*Product) ApprovalRequired added in v0.17.2 

func (r *Product) ApprovalRequired() *pulumi.BoolOutput

Do subscribers need to be approved prior to being able to use the Product?

func (*Product) Description added in v0.17.2 

func (r *Product) Description() *pulumi.StringOutput

A description of this Product, which may include HTML formatting tags.

func (*Product) DisplayName added in v0.17.2 

func (r *Product) DisplayName() *pulumi.StringOutput

The Display Name for this API Management Product.

func (*Product) ID added in v0.17.2 

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

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

func (*Product) ProductId added in v0.17.2 

func (r *Product) ProductId() *pulumi.StringOutput

The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.

func (*Product) Published added in v0.17.2 

func (r *Product) Published() *pulumi.BoolOutput

Is this Product Published?

func (*Product) ResourceGroupName added in v0.17.2 

func (r *Product) 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 (*Product) SubscriptionRequired added in v0.17.2 

func (r *Product) SubscriptionRequired() *pulumi.BoolOutput

Is a Subscription required to access API's included in this Product?

func (*Product) SubscriptionsLimit added in v0.17.2 

func (r *Product) SubscriptionsLimit() *pulumi.IntOutput

The number of subscriptions a user can have to this Product at the same time.

func (*Product) Terms added in v0.17.2 

func (r *Product) Terms() *pulumi.StringOutput

The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

func (*Product) URN added in v0.17.2 

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

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

type ProductArgs added in v0.17.2 

type ProductArgs struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// Do subscribers need to be approved prior to being able to use the Product?
	ApprovalRequired interface{}
	// A description of this Product, which may include HTML formatting tags.
	Description interface{}
	// The Display Name for this API Management Product.
	DisplayName interface{}
	// The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
	ProductId interface{}
	// Is this Product Published?
	Published 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{}
	// Is a Subscription required to access API's included in this Product?
	SubscriptionRequired interface{}
	// The number of subscriptions a user can have to this Product at the same time.
	SubscriptionsLimit interface{}
	// The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
	Terms interface{}
}

The set of arguments for constructing a Product resource.

type ProductGroup added in v0.17.2 

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

Manages an API Management Product Assignment to a Group.

func GetProductGroup added in v0.17.2 

func GetProductGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ProductGroupState, opts ...pulumi.ResourceOpt) (*ProductGroup, error)

GetProductGroup gets an existing ProductGroup 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 NewProductGroup added in v0.17.2 

func NewProductGroup(ctx *pulumi.Context,
	name string, args *ProductGroupArgs, opts ...pulumi.ResourceOpt) (*ProductGroup, error)

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

func (*ProductGroup) ApiManagementName added in v0.17.2 

func (r *ProductGroup) ApiManagementName() *pulumi.StringOutput

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

func (*ProductGroup) GroupName added in v0.17.2 

func (r *ProductGroup) GroupName() *pulumi.StringOutput

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

func (*ProductGroup) ID added in v0.17.2 

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

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

func (*ProductGroup) ProductId added in v0.17.2 

func (r *ProductGroup) ProductId() *pulumi.StringOutput

func (*ProductGroup) ResourceGroupName added in v0.17.2 

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

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

func (*ProductGroup) URN added in v0.17.2 

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

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

type ProductGroupArgs added in v0.17.2 

type ProductGroupArgs struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The Name of the API Management Group within the API Management Service. Changing this forces a new resource to be created.
	GroupName interface{}
	ProductId interface{}
	// The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

The set of arguments for constructing a ProductGroup resource.

type ProductGroupState added in v0.17.2 

type ProductGroupState struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The Name of the API Management Group within the API Management Service. Changing this forces a new resource to be created.
	GroupName interface{}
	ProductId interface{}
	// The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

Input properties used for looking up and filtering ProductGroup resources.

type ProductState added in v0.17.2 

type ProductState struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// Do subscribers need to be approved prior to being able to use the Product?
	ApprovalRequired interface{}
	// A description of this Product, which may include HTML formatting tags.
	Description interface{}
	// The Display Name for this API Management Product.
	DisplayName interface{}
	// The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
	ProductId interface{}
	// Is this Product Published?
	Published 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{}
	// Is a Subscription required to access API's included in this Product?
	SubscriptionRequired interface{}
	// The number of subscriptions a user can have to this Product at the same time.
	SubscriptionsLimit interface{}
	// The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
	Terms interface{}
}

Input properties used for looking up and filtering Product resources.

type Property added in v0.17.2 

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

Manages an API Management Property.

func GetProperty added in v0.17.2 

func GetProperty(ctx *pulumi.Context,
	name string, id pulumi.ID, state *PropertyState, opts ...pulumi.ResourceOpt) (*Property, error)

GetProperty gets an existing Property 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 NewProperty added in v0.17.2 

func NewProperty(ctx *pulumi.Context,
	name string, args *PropertyArgs, opts ...pulumi.ResourceOpt) (*Property, error)

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

func (*Property) ApiManagementName added in v0.17.2 

func (r *Property) ApiManagementName() *pulumi.StringOutput

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

func (*Property) DisplayName added in v0.17.2 

func (r *Property) DisplayName() *pulumi.StringOutput

The display name of this API Management Property.

func (*Property) ID added in v0.17.2 

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

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

func (*Property) Name added in v0.17.2 

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

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

func (*Property) ResourceGroupName added in v0.17.2 

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

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

func (*Property) Secret added in v0.17.2 

func (r *Property) Secret() *pulumi.BoolOutput

Specifies whether the API Management Property is secret. Valid values are `true` or `false`. The default value is `false`.

func (*Property) Tags added in v0.17.2 

func (r *Property) Tags() *pulumi.ArrayOutput

A list of tags to be applied to the API Management Property.

func (*Property) URN added in v0.17.2 

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

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

func (*Property) Value added in v0.17.2 

func (r *Property) Value() *pulumi.StringOutput

The value of this API Management Property.

type PropertyArgs added in v0.17.2 

type PropertyArgs struct {
	// The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The display name of this API Management Property.
	DisplayName interface{}
	// The name of the API Management Property. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// Specifies whether the API Management Property is secret. Valid values are `true` or `false`. The default value is `false`.
	Secret interface{}
	// A list of tags to be applied to the API Management Property.
	Tags interface{}
	// The value of this API Management Property.
	Value interface{}
}

The set of arguments for constructing a Property resource.

type PropertyState added in v0.17.2 

type PropertyState struct {
	// The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The display name of this API Management Property.
	DisplayName interface{}
	// The name of the API Management Property. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// Specifies whether the API Management Property is secret. Valid values are `true` or `false`. The default value is `false`.
	Secret interface{}
	// A list of tags to be applied to the API Management Property.
	Tags interface{}
	// The value of this API Management Property.
	Value interface{}
}

Input properties used for looking up and filtering Property resources.

type User added in v0.17.2 

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

Manages an API Management User.

func GetUser added in v0.17.2 

func GetUser(ctx *pulumi.Context,
	name string, id pulumi.ID, state *UserState, opts ...pulumi.ResourceOpt) (*User, error)

GetUser gets an existing User 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 NewUser added in v0.17.2 

func NewUser(ctx *pulumi.Context,
	name string, args *UserArgs, opts ...pulumi.ResourceOpt) (*User, error)

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

func (*User) ApiManagementName added in v0.17.2 

func (r *User) ApiManagementName() *pulumi.StringOutput

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

func (*User) Confirmation added in v0.17.2 

func (r *User) Confirmation() *pulumi.StringOutput

The kind of confirmation email which will be sent to this user. Possible values are `invite` and `signup`. Changing this forces a new resource to be created.

func (*User) Email added in v0.17.2 

func (r *User) Email() *pulumi.StringOutput

The email address associated with this user.

func (*User) FirstName added in v0.17.2 

func (r *User) FirstName() *pulumi.StringOutput

The first name for this user.

func (*User) ID added in v0.17.2 

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

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

func (*User) LastName added in v0.17.2 

func (r *User) LastName() *pulumi.StringOutput

The last name for this user.

func (*User) Note added in v0.17.2 

func (r *User) Note() *pulumi.StringOutput

A note about this user.

func (*User) Password added in v0.17.2 

func (r *User) Password() *pulumi.StringOutput

The password associated with this user.

func (*User) ResourceGroupName added in v0.17.2 

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

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

func (*User) State added in v0.17.2 

func (r *User) State() *pulumi.StringOutput

The state of this user. Possible values are `active`, `blocked` and `pending`.

func (*User) URN added in v0.17.2 

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

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

func (*User) UserId added in v0.17.2 

func (r *User) UserId() *pulumi.StringOutput

The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.

type UserArgs added in v0.17.2 

type UserArgs struct {
	// The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The kind of confirmation email which will be sent to this user. Possible values are `invite` and `signup`. Changing this forces a new resource to be created.
	Confirmation interface{}
	// The email address associated with this user.
	Email interface{}
	// The first name for this user.
	FirstName interface{}
	// The last name for this user.
	LastName interface{}
	// A note about this user.
	Note interface{}
	// The password associated with this user.
	Password interface{}
	// The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The state of this user. Possible values are `active`, `blocked` and `pending`.
	State interface{}
	// The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.
	UserId interface{}
}

The set of arguments for constructing a User resource.

type UserState added in v0.17.2 

type UserState struct {
	// The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The kind of confirmation email which will be sent to this user. Possible values are `invite` and `signup`. Changing this forces a new resource to be created.
	Confirmation interface{}
	// The email address associated with this user.
	Email interface{}
	// The first name for this user.
	FirstName interface{}
	// The last name for this user.
	LastName interface{}
	// A note about this user.
	Note interface{}
	// The password associated with this user.
	Password interface{}
	// The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The state of this user. Possible values are `active`, `blocked` and `pending`.
	State interface{}
	// The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.
	UserId interface{}
}

Input properties used for looking up and filtering User resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.