apimanagement

package
v0.19.3 Latest Latest
Warning

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

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

Documentation

Overview

nolint: lll Package apimanagement exports types, functions, subpackages for provisioning apimanagement resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-azurerm) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-azure` repo](https://github.com/pulumi/pulumi-azure/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-azurerm` repo](https://github.com/terraform-providers/terraform-provider-azurerm/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Api added in v0.18.0 

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

Manages an API within an API Management Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_api.html.markdown.

func GetApi added in v0.18.0 

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

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) ApiManagementName added in v0.18.0 

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

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

func (*Api) Description added in v0.18.0 

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

A description of the API Management API, which may include HTML formatting tags.

func (*Api) DisplayName added in v0.18.0 

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

The display name of the API.

func (*Api) ID added in v0.18.0 

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

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

func (*Api) Import added in v0.18.0 

func (r *Api) Import() *pulumi.Output

A `import` block as documented below.

func (*Api) IsCurrent added in v0.18.0 

func (r *Api) IsCurrent() *pulumi.BoolOutput

Is this the current API Revision?

func (*Api) IsOnline added in v0.18.0 

func (r *Api) IsOnline() *pulumi.BoolOutput

Is this API Revision online/accessible via the Gateway?

func (*Api) Name added in v0.18.0 

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

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

func (*Api) Path added in v0.18.0 

func (r *Api) Path() *pulumi.StringOutput

The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of it's resource paths within the API Management Service.

func (*Api) Protocols added in v0.18.0 

func (r *Api) Protocols() *pulumi.ArrayOutput

A list of protocols the operations in this API can be invoked. Possible values are `http` and `https`.

func (*Api) ResourceGroupName added in v0.18.0 

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

The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.

func (*Api) Revision added in v0.18.0 

func (r *Api) Revision() *pulumi.StringOutput

The Revision which used for this API.

func (*Api) ServiceUrl added in v0.18.0 

func (r *Api) ServiceUrl() *pulumi.StringOutput

Absolute URL of the backend service implementing this API.

func (*Api) SoapPassThrough added in v0.18.0 

func (r *Api) SoapPassThrough() *pulumi.BoolOutput

Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to `false`.

func (*Api) SubscriptionKeyParameterNames added in v0.18.0 

func (r *Api) SubscriptionKeyParameterNames() *pulumi.Output

A `subscription_key_parameter_names` block as documented below.

func (*Api) URN added in v0.18.0 

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

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

func (*Api) Version added in v0.18.0 

func (r *Api) Version() *pulumi.StringOutput

The Version number of this API, if this API is versioned.

func (*Api) VersionSetId added in v0.18.0 

func (r *Api) VersionSetId() *pulumi.StringOutput

The ID of the Version Set which this API is associated with.

type ApiArgs added in v0.18.0 

type ApiArgs struct {
	// The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// A description of the API Management API, which may include HTML formatting tags.
	Description interface{}
	// The display name of the API.
	DisplayName interface{}
	// A `import` block as documented below.
	Import interface{}
	// The name of the API Management API. Changing this forces a new resource to be created.
	Name interface{}
	// The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of it's resource paths within the API Management Service.
	Path interface{}
	// A list of protocols the operations in this API can be invoked. Possible values are `http` and `https`.
	Protocols interface{}
	// The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The Revision which used for this API.
	Revision interface{}
	// Absolute URL of the backend service implementing this API.
	ServiceUrl interface{}
	// Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to `false`.
	SoapPassThrough interface{}
	// A `subscription_key_parameter_names` block as documented below.
	SubscriptionKeyParameterNames interface{}
}

The set of arguments for constructing a Api resource.

type ApiOperation added in v0.18.0 

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

Manages an API Operation within an API Management Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_api_operation.html.markdown.

func GetApiOperation added in v0.18.0 

func GetApiOperation(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ApiOperationState, opts ...pulumi.ResourceOpt) (*ApiOperation, error)

GetApiOperation gets an existing ApiOperation 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 NewApiOperation added in v0.18.0 

func NewApiOperation(ctx *pulumi.Context,
	name string, args *ApiOperationArgs, opts ...pulumi.ResourceOpt) (*ApiOperation, error)

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

func (*ApiOperation) ApiManagementName added in v0.18.0 

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

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

func (*ApiOperation) ApiName added in v0.18.0 

func (r *ApiOperation) ApiName() *pulumi.StringOutput

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

func (*ApiOperation) Description added in v0.18.0 

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

A description for this API Operation, which may include HTML formatting tags.

func (*ApiOperation) DisplayName added in v0.18.0 

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

The Display Name for this API Management Operation.

func (*ApiOperation) ID added in v0.18.0 

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

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

func (*ApiOperation) Method added in v0.18.0 

func (r *ApiOperation) Method() *pulumi.StringOutput

The HTTP Method used for this API Management Operation, like `GET`, `DELETE`, `PUT` or `POST` - but not limited to these values.

func (*ApiOperation) OperationId added in v0.18.0 

func (r *ApiOperation) OperationId() *pulumi.StringOutput

A unique identifier for this API Operation. Changing this forces a new resource to be created.

func (*ApiOperation) Request added in v0.18.0 

func (r *ApiOperation) Request() *pulumi.Output

A `request` block as defined below.

func (*ApiOperation) ResourceGroupName added in v0.18.0 

func (r *ApiOperation) 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 (*ApiOperation) Responses added in v0.18.0 

func (r *ApiOperation) Responses() *pulumi.ArrayOutput

One or more `response` blocks as defined below.

func (*ApiOperation) TemplateParameters added in v0.18.0 

func (r *ApiOperation) TemplateParameters() *pulumi.ArrayOutput

One or more `template_parameter` blocks as defined below.

func (*ApiOperation) URN added in v0.18.0 

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

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

func (*ApiOperation) UrlTemplate added in v0.18.0 

func (r *ApiOperation) UrlTemplate() *pulumi.StringOutput

The relative URL Template identifying the target resource for this operation, which may include parameters.

type ApiOperationArgs added in v0.18.0 

type ApiOperationArgs struct {
	// The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
	ApiName interface{}
	// A description for this API Operation, which may include HTML formatting tags.
	Description interface{}
	// The Display Name for this API Management Operation.
	DisplayName interface{}
	// The HTTP Method used for this API Management Operation, like `GET`, `DELETE`, `PUT` or `POST` - but not limited to these values.
	Method interface{}
	// A unique identifier for this API Operation. Changing this forces a new resource to be created.
	OperationId interface{}
	// A `request` block as defined below.
	Request 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{}
	// One or more `response` blocks as defined below.
	Responses interface{}
	// One or more `template_parameter` blocks as defined below.
	TemplateParameters interface{}
	// The relative URL Template identifying the target resource for this operation, which may include parameters.
	UrlTemplate interface{}
}

The set of arguments for constructing a ApiOperation resource.

type ApiOperationPolicy added in v0.18.3 

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

Manages an API Management API Operation Policy

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_api_operation_policy.html.markdown.

func GetApiOperationPolicy added in v0.18.3 

func GetApiOperationPolicy(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ApiOperationPolicyState, opts ...pulumi.ResourceOpt) (*ApiOperationPolicy, error)

GetApiOperationPolicy gets an existing ApiOperationPolicy 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 NewApiOperationPolicy added in v0.18.3 

func NewApiOperationPolicy(ctx *pulumi.Context,
	name string, args *ApiOperationPolicyArgs, opts ...pulumi.ResourceOpt) (*ApiOperationPolicy, error)

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

func (*ApiOperationPolicy) ApiManagementName added in v0.18.3 

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

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

func (*ApiOperationPolicy) ApiName added in v0.18.3 

func (r *ApiOperationPolicy) ApiName() *pulumi.StringOutput

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

func (*ApiOperationPolicy) ID added in v0.18.3 

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

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

func (*ApiOperationPolicy) OperationId added in v0.18.3 

func (r *ApiOperationPolicy) OperationId() *pulumi.StringOutput

func (*ApiOperationPolicy) ResourceGroupName added in v0.18.3 

func (r *ApiOperationPolicy) 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 (*ApiOperationPolicy) URN added in v0.18.3 

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

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

func (*ApiOperationPolicy) XmlContent added in v0.18.3 

func (r *ApiOperationPolicy) XmlContent() *pulumi.StringOutput

The XML Content for this Policy. 

func (r *ApiOperationPolicy) XmlLink() *pulumi.StringOutput

A link to a Policy XML Document, which must be publicly available.

type ApiOperationPolicyArgs added in v0.18.3 

type ApiOperationPolicyArgs struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The ID of the API Management API Operation within the API Management Service. Changing this forces a new resource to be created.
	ApiName     interface{}
	OperationId 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 XML Content for this Policy.
	XmlContent interface{}
	// A link to a Policy XML Document, which must be publicly available.
	XmlLink interface{}
}

The set of arguments for constructing a ApiOperationPolicy resource.

type ApiOperationPolicyState added in v0.18.3 

type ApiOperationPolicyState struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The ID of the API Management API Operation within the API Management Service. Changing this forces a new resource to be created.
	ApiName     interface{}
	OperationId 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 XML Content for this Policy.
	XmlContent interface{}
	// A link to a Policy XML Document, which must be publicly available.
	XmlLink interface{}
}

Input properties used for looking up and filtering ApiOperationPolicy resources.

type ApiOperationState added in v0.18.0 

type ApiOperationState struct {
	// The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
	ApiName interface{}
	// A description for this API Operation, which may include HTML formatting tags.
	Description interface{}
	// The Display Name for this API Management Operation.
	DisplayName interface{}
	// The HTTP Method used for this API Management Operation, like `GET`, `DELETE`, `PUT` or `POST` - but not limited to these values.
	Method interface{}
	// A unique identifier for this API Operation. Changing this forces a new resource to be created.
	OperationId interface{}
	// A `request` block as defined below.
	Request 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{}
	// One or more `response` blocks as defined below.
	Responses interface{}
	// One or more `template_parameter` blocks as defined below.
	TemplateParameters interface{}
	// The relative URL Template identifying the target resource for this operation, which may include parameters.
	UrlTemplate interface{}
}

Input properties used for looking up and filtering ApiOperation resources.

type ApiPolicy added in v0.18.3 

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

Manages an API Management API Policy

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_api_policy.html.markdown.

func GetApiPolicy added in v0.18.3 

func GetApiPolicy(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ApiPolicyState, opts ...pulumi.ResourceOpt) (*ApiPolicy, error)

GetApiPolicy gets an existing ApiPolicy 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 NewApiPolicy added in v0.18.3 

func NewApiPolicy(ctx *pulumi.Context,
	name string, args *ApiPolicyArgs, opts ...pulumi.ResourceOpt) (*ApiPolicy, error)

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

func (*ApiPolicy) ApiManagementName added in v0.18.3 

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

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

func (*ApiPolicy) ApiName added in v0.18.3 

func (r *ApiPolicy) ApiName() *pulumi.StringOutput

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

func (*ApiPolicy) ID added in v0.18.3 

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

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

func (*ApiPolicy) ResourceGroupName added in v0.18.3 

func (r *ApiPolicy) 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 (*ApiPolicy) URN added in v0.18.3 

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

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

func (*ApiPolicy) XmlContent added in v0.18.3 

func (r *ApiPolicy) XmlContent() *pulumi.StringOutput

The XML Content for this Policy. 

func (r *ApiPolicy) XmlLink() *pulumi.StringOutput

A link to a Policy XML Document, which must be publicly available.

type ApiPolicyArgs added in v0.18.3 

type ApiPolicyArgs struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The ID of the API Management API within the API Management Service. Changing this forces a new resource to be created.
	ApiName 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 XML Content for this Policy.
	XmlContent interface{}
	// A link to a Policy XML Document, which must be publicly available.
	XmlLink interface{}
}

The set of arguments for constructing a ApiPolicy resource.

type ApiPolicyState added in v0.18.3 

type ApiPolicyState struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The ID of the API Management API within the API Management Service. Changing this forces a new resource to be created.
	ApiName 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 XML Content for this Policy.
	XmlContent interface{}
	// A link to a Policy XML Document, which must be publicly available.
	XmlLink interface{}
}

Input properties used for looking up and filtering ApiPolicy resources.

type ApiSchema added in v0.18.3 

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

Manages an API Schema within an API Management Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_api_schema.html.markdown.

func GetApiSchema added in v0.18.3 

func GetApiSchema(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ApiSchemaState, opts ...pulumi.ResourceOpt) (*ApiSchema, error)

GetApiSchema gets an existing ApiSchema 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 NewApiSchema added in v0.18.3 

func NewApiSchema(ctx *pulumi.Context,
	name string, args *ApiSchemaArgs, opts ...pulumi.ResourceOpt) (*ApiSchema, error)

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

func (*ApiSchema) ApiManagementName added in v0.18.3 

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

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

func (*ApiSchema) ApiName added in v0.18.3 

func (r *ApiSchema) ApiName() *pulumi.StringOutput

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

func (*ApiSchema) ContentType added in v0.18.3 

func (r *ApiSchema) ContentType() *pulumi.StringOutput

The content type of the API Schema.

func (*ApiSchema) ID added in v0.18.3 

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

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

func (*ApiSchema) ResourceGroupName added in v0.18.3 

func (r *ApiSchema) 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 (*ApiSchema) SchemaId added in v0.18.3 

func (r *ApiSchema) SchemaId() *pulumi.StringOutput

A unique identifier for this API Schema. Changing this forces a new resource to be created.

func (*ApiSchema) URN added in v0.18.3 

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

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

func (*ApiSchema) Value added in v0.18.3 

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

The JSON escaped string defining the document representing the Schema.

type ApiSchemaArgs added in v0.18.3 

type ApiSchemaArgs struct {
	// The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The name of the API within the API Management Service where this API Schema should be created. Changing this forces a new resource to be created.
	ApiName interface{}
	// The content type of the API Schema.
	ContentType 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{}
	// A unique identifier for this API Schema. Changing this forces a new resource to be created.
	SchemaId interface{}
	// The JSON escaped string defining the document representing the Schema.
	Value interface{}
}

The set of arguments for constructing a ApiSchema resource.

type ApiSchemaState added in v0.18.3 

type ApiSchemaState struct {
	// The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The name of the API within the API Management Service where this API Schema should be created. Changing this forces a new resource to be created.
	ApiName interface{}
	// The content type of the API Schema.
	ContentType 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{}
	// A unique identifier for this API Schema. Changing this forces a new resource to be created.
	SchemaId interface{}
	// The JSON escaped string defining the document representing the Schema.
	Value interface{}
}

Input properties used for looking up and filtering ApiSchema resources.

type ApiState added in v0.18.0 

type ApiState struct {
	// The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// A description of the API Management API, which may include HTML formatting tags.
	Description interface{}
	// The display name of the API.
	DisplayName interface{}
	// A `import` block as documented below.
	Import interface{}
	// Is this the current API Revision?
	IsCurrent interface{}
	// Is this API Revision online/accessible via the Gateway?
	IsOnline interface{}
	// The name of the API Management API. Changing this forces a new resource to be created.
	Name interface{}
	// The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of it's resource paths within the API Management Service.
	Path interface{}
	// A list of protocols the operations in this API can be invoked. Possible values are `http` and `https`.
	Protocols interface{}
	// The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The Revision which used for this API.
	Revision interface{}
	// Absolute URL of the backend service implementing this API.
	ServiceUrl interface{}
	// Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to `false`.
	SoapPassThrough interface{}
	// A `subscription_key_parameter_names` block as documented below.
	SubscriptionKeyParameterNames interface{}
	// The Version number of this API, if this API is versioned.
	Version interface{}
	// The ID of the Version Set which this API is associated with.
	VersionSetId interface{}
}

Input properties used for looking up and filtering Api resources.

type ApiVersionSet added in v0.18.0 

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

Manages an API Version Set within a API Management Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_api_version_set.html.markdown.

func GetApiVersionSet added in v0.18.0 

func GetApiVersionSet(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ApiVersionSetState, opts ...pulumi.ResourceOpt) (*ApiVersionSet, error)

GetApiVersionSet gets an existing ApiVersionSet 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 NewApiVersionSet added in v0.18.0 

func NewApiVersionSet(ctx *pulumi.Context,
	name string, args *ApiVersionSetArgs, opts ...pulumi.ResourceOpt) (*ApiVersionSet, error)

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

func (*ApiVersionSet) ApiManagementName added in v0.18.0 

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

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

func (*ApiVersionSet) Description added in v0.18.0 

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

The description of API Version Set.

func (*ApiVersionSet) DisplayName added in v0.18.0 

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

The display name of this API Version Set.

func (*ApiVersionSet) ID added in v0.18.0 

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

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

func (*ApiVersionSet) Name added in v0.18.0 

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

The name of the API Version Set. Changing this forces a new resource to be created.

func (*ApiVersionSet) ResourceGroupName added in v0.18.0 

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

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

func (*ApiVersionSet) URN added in v0.18.0 

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

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

func (*ApiVersionSet) VersionHeaderName added in v0.18.0 

func (r *ApiVersionSet) VersionHeaderName() *pulumi.StringOutput

The name of the Header which should be read from Inbound Requests which defines the API Version.

func (*ApiVersionSet) VersionQueryName added in v0.18.0 

func (r *ApiVersionSet) VersionQueryName() *pulumi.StringOutput

The name of the Query String which should be read from Inbound Requests which defines the API Version.

func (*ApiVersionSet) VersioningScheme added in v0.18.0 

func (r *ApiVersionSet) VersioningScheme() *pulumi.StringOutput

Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are `Header`, `Query` and `Segment`.

type ApiVersionSetArgs added in v0.18.0 

type ApiVersionSetArgs struct {
	// The name of the API Management Service in which the API Version Set should exist. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The description of API Version Set.
	Description interface{}
	// The display name of this API Version Set.
	DisplayName interface{}
	// The name of the API Version Set. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The name of the Header which should be read from Inbound Requests which defines the API Version.
	VersionHeaderName interface{}
	// The name of the Query String which should be read from Inbound Requests which defines the API Version.
	VersionQueryName interface{}
	// Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are `Header`, `Query` and `Segment`.
	VersioningScheme interface{}
}

The set of arguments for constructing a ApiVersionSet resource.

type ApiVersionSetState added in v0.18.0 

type ApiVersionSetState struct {
	// The name of the API Management Service in which the API Version Set should exist. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The description of API Version Set.
	Description interface{}
	// The display name of this API Version Set.
	DisplayName interface{}
	// The name of the API Version Set. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The name of the Header which should be read from Inbound Requests which defines the API Version.
	VersionHeaderName interface{}
	// The name of the Query String which should be read from Inbound Requests which defines the API Version.
	VersionQueryName interface{}
	// Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are `Header`, `Query` and `Segment`.
	VersioningScheme interface{}
}

Input properties used for looking up and filtering ApiVersionSet resources.

type AuthorizationServer added in v0.18.0 

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

Manages an Authorization Server within an API Management Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_authorization_server.html.markdown.

func GetAuthorizationServer added in v0.18.0 

func GetAuthorizationServer(ctx *pulumi.Context,
	name string, id pulumi.ID, state *AuthorizationServerState, opts ...pulumi.ResourceOpt) (*AuthorizationServer, error)

GetAuthorizationServer gets an existing AuthorizationServer 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 NewAuthorizationServer added in v0.18.0 

func NewAuthorizationServer(ctx *pulumi.Context,
	name string, args *AuthorizationServerArgs, opts ...pulumi.ResourceOpt) (*AuthorizationServer, error)

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

func (*AuthorizationServer) ApiManagementName added in v0.18.0 

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

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

func (*AuthorizationServer) AuthorizationEndpoint added in v0.18.0 

func (r *AuthorizationServer) AuthorizationEndpoint() *pulumi.StringOutput

The OAUTH Authorization Endpoint.

func (*AuthorizationServer) AuthorizationMethods added in v0.18.0 

func (r *AuthorizationServer) AuthorizationMethods() *pulumi.ArrayOutput

The HTTP Verbs supported by the Authorization Endpoint. Possible values are `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, `PUT` and `TRACE`.

func (*AuthorizationServer) BearerTokenSendingMethods added in v0.18.0 

func (r *AuthorizationServer) BearerTokenSendingMethods() *pulumi.ArrayOutput

The mechanism by which Access Tokens are passed to the API. Possible values are `authorizationHeader` and `query`.

func (*AuthorizationServer) ClientAuthenticationMethods added in v0.18.0 

func (r *AuthorizationServer) ClientAuthenticationMethods() *pulumi.ArrayOutput

The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are `Basic` and `Body`.

func (*AuthorizationServer) ClientId added in v0.18.0 

func (r *AuthorizationServer) ClientId() *pulumi.StringOutput

The Client/App ID registered with this Authorization Server.

func (*AuthorizationServer) ClientRegistrationEndpoint added in v0.18.0 

func (r *AuthorizationServer) ClientRegistrationEndpoint() *pulumi.StringOutput

The URI of page where Client/App Registration is performed for this Authorization Server.

func (*AuthorizationServer) ClientSecret added in v0.18.0 

func (r *AuthorizationServer) ClientSecret() *pulumi.StringOutput

The Client/App Secret registered with this Authorization Server.

func (*AuthorizationServer) DefaultScope added in v0.18.0 

func (r *AuthorizationServer) DefaultScope() *pulumi.StringOutput

The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.

func (*AuthorizationServer) Description added in v0.18.0 

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

A description of the Authorization Server, which may contain HTML formatting tags.

func (*AuthorizationServer) DisplayName added in v0.18.0 

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

The user-friendly name of this Authorization Server.

func (*AuthorizationServer) GrantTypes added in v0.18.0 

func (r *AuthorizationServer) GrantTypes() *pulumi.ArrayOutput

Form of Authorization Grants required when requesting an Access Token. Possible values are `authorizationCode`, `clientCredentials`, `implicit` and `resourceOwnerPassword`.

func (*AuthorizationServer) ID added in v0.18.0 

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

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

func (*AuthorizationServer) Name added in v0.18.0 

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

The name of this Authorization Server. Changing this forces a new resource to be created.

func (*AuthorizationServer) ResourceGroupName added in v0.18.0 

func (r *AuthorizationServer) 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 (*AuthorizationServer) ResourceOwnerPassword added in v0.18.0 

func (r *AuthorizationServer) ResourceOwnerPassword() *pulumi.StringOutput

The password associated with the Resource Owner.

func (*AuthorizationServer) ResourceOwnerUsername added in v0.18.0 

func (r *AuthorizationServer) ResourceOwnerUsername() *pulumi.StringOutput

The username associated with the Resource Owner.

func (*AuthorizationServer) SupportState added in v0.18.0 

func (r *AuthorizationServer) SupportState() *pulumi.BoolOutput

Does this Authorization Server support State? If this is set to `true` the client may use the state parameter to raise protocol security.

func (*AuthorizationServer) TokenBodyParameters added in v0.18.0 

func (r *AuthorizationServer) TokenBodyParameters() *pulumi.ArrayOutput

func (*AuthorizationServer) TokenEndpoint added in v0.18.0 

func (r *AuthorizationServer) TokenEndpoint() *pulumi.StringOutput

The OAUTH Token Endpoint.

func (*AuthorizationServer) URN added in v0.18.0 

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

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

type AuthorizationServerArgs added in v0.18.0 

type AuthorizationServerArgs struct {
	// The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The OAUTH Authorization Endpoint.
	AuthorizationEndpoint interface{}
	// The HTTP Verbs supported by the Authorization Endpoint. Possible values are `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, `PUT` and `TRACE`.
	AuthorizationMethods interface{}
	// The mechanism by which Access Tokens are passed to the API. Possible values are `authorizationHeader` and `query`.
	BearerTokenSendingMethods interface{}
	// The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are `Basic` and `Body`.
	ClientAuthenticationMethods interface{}
	// The Client/App ID registered with this Authorization Server.
	ClientId interface{}
	// The URI of page where Client/App Registration is performed for this Authorization Server.
	ClientRegistrationEndpoint interface{}
	// The Client/App Secret registered with this Authorization Server.
	ClientSecret interface{}
	// The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
	DefaultScope interface{}
	// A description of the Authorization Server, which may contain HTML formatting tags.
	Description interface{}
	// The user-friendly name of this Authorization Server.
	DisplayName interface{}
	// Form of Authorization Grants required when requesting an Access Token. Possible values are `authorizationCode`, `clientCredentials`, `implicit` and `resourceOwnerPassword`.
	GrantTypes interface{}
	// The name of this Authorization Server. Changing this forces a new resource to be created.
	Name 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 password associated with the Resource Owner.
	ResourceOwnerPassword interface{}
	// The username associated with the Resource Owner.
	ResourceOwnerUsername interface{}
	// Does this Authorization Server support State? If this is set to `true` the client may use the state parameter to raise protocol security.
	SupportState        interface{}
	TokenBodyParameters interface{}
	// The OAUTH Token Endpoint.
	TokenEndpoint interface{}
}

The set of arguments for constructing a AuthorizationServer resource.

type AuthorizationServerState added in v0.18.0 

type AuthorizationServerState struct {
	// The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The OAUTH Authorization Endpoint.
	AuthorizationEndpoint interface{}
	// The HTTP Verbs supported by the Authorization Endpoint. Possible values are `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, `PUT` and `TRACE`.
	AuthorizationMethods interface{}
	// The mechanism by which Access Tokens are passed to the API. Possible values are `authorizationHeader` and `query`.
	BearerTokenSendingMethods interface{}
	// The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are `Basic` and `Body`.
	ClientAuthenticationMethods interface{}
	// The Client/App ID registered with this Authorization Server.
	ClientId interface{}
	// The URI of page where Client/App Registration is performed for this Authorization Server.
	ClientRegistrationEndpoint interface{}
	// The Client/App Secret registered with this Authorization Server.
	ClientSecret interface{}
	// The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
	DefaultScope interface{}
	// A description of the Authorization Server, which may contain HTML formatting tags.
	Description interface{}
	// The user-friendly name of this Authorization Server.
	DisplayName interface{}
	// Form of Authorization Grants required when requesting an Access Token. Possible values are `authorizationCode`, `clientCredentials`, `implicit` and `resourceOwnerPassword`.
	GrantTypes interface{}
	// The name of this Authorization Server. Changing this forces a new resource to be created.
	Name 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 password associated with the Resource Owner.
	ResourceOwnerPassword interface{}
	// The username associated with the Resource Owner.
	ResourceOwnerUsername interface{}
	// Does this Authorization Server support State? If this is set to `true` the client may use the state parameter to raise protocol security.
	SupportState        interface{}
	TokenBodyParameters interface{}
	// The OAUTH Token Endpoint.
	TokenEndpoint interface{}
}

Input properties used for looking up and filtering AuthorizationServer resources.

type Certificate added in v0.18.0 

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

Manages an Certificate within an API Management Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_certificate.html.markdown.

func GetCertificate added in v0.18.0 

func GetCertificate(ctx *pulumi.Context,
	name string, id pulumi.ID, state *CertificateState, opts ...pulumi.ResourceOpt) (*Certificate, error)

GetCertificate gets an existing Certificate 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 NewCertificate added in v0.18.0 

func NewCertificate(ctx *pulumi.Context,
	name string, args *CertificateArgs, opts ...pulumi.ResourceOpt) (*Certificate, error)

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

func (*Certificate) ApiManagementName added in v0.18.0 

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

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

func (*Certificate) Data added in v0.18.0 

func (r *Certificate) Data() *pulumi.StringOutput

The base-64 encoded certificate data, which must be a PFX file. Changing this forces a new resource to be created.

func (*Certificate) Expiration added in v0.18.0 

func (r *Certificate) Expiration() *pulumi.StringOutput

The Expiration Date of this Certificate, formatted as an RFC3339 string.

func (*Certificate) ID added in v0.18.0 

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

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

func (*Certificate) Name added in v0.18.0 

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

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

func (*Certificate) Password added in v0.18.0 

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

The password used for this certificate. Changing this forces a new resource to be created.

func (*Certificate) ResourceGroupName added in v0.18.0 

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

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

func (*Certificate) Subject added in v0.18.0 

func (r *Certificate) Subject() *pulumi.StringOutput

The Subject of this Certificate.

func (*Certificate) Thumbprint added in v0.18.0 

func (r *Certificate) Thumbprint() *pulumi.StringOutput

The Thumbprint of this Certificate.

func (*Certificate) URN added in v0.18.0 

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

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

type CertificateArgs added in v0.18.0 

type CertificateArgs struct {
	// The Name of the API Management Service where this Service should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The base-64 encoded certificate data, which must be a PFX file. Changing this forces a new resource to be created.
	Data interface{}
	// The name of the API Management Certificate. Changing this forces a new resource to be created.
	Name interface{}
	// The password used for this certificate. Changing this forces a new resource to be created.
	Password interface{}
	// The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

The set of arguments for constructing a Certificate resource.

type CertificateState added in v0.18.0 

type CertificateState struct {
	// The Name of the API Management Service where this Service should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The base-64 encoded certificate data, which must be a PFX file. Changing this forces a new resource to be created.
	Data interface{}
	// The Expiration Date of this Certificate, formatted as an RFC3339 string.
	Expiration interface{}
	// The name of the API Management Certificate. Changing this forces a new resource to be created.
	Name interface{}
	// The password used for this certificate. Changing this forces a new resource to be created.
	Password interface{}
	// The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The Subject of this Certificate.
	Subject interface{}
	// The Thumbprint of this Certificate.
	Thumbprint interface{}
}

Input properties used for looking up and filtering Certificate resources.

type GetApiArgs added in v0.18.0 

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

A collection of arguments for invoking getApi.

type GetApiResult added in v0.18.0 

type GetApiResult struct {
	ApiManagementName interface{}
	// A description of the API Management API, which may include HTML formatting tags.
	Description interface{}
	// The display name of the API.
	DisplayName interface{}
	// Is this the current API Revision?
	IsCurrent interface{}
	// Is this API Revision online/accessible via the Gateway?
	IsOnline interface{}
	Name     interface{}
	// The Path for this API Management API.
	Path interface{}
	// A list of protocols the operations in this API can be invoked.
	Protocols         interface{}
	ResourceGroupName interface{}
	Revision          interface{}
	// Absolute URL of the backend service implementing this API.
	ServiceUrl interface{}
	// Should this API expose a SOAP frontend, rather than a HTTP frontend?
	SoapPassThrough interface{}
	// A `subscription_key_parameter_names` block as documented below.
	SubscriptionKeyParameterNames interface{}
	// The Version number of this API, if this API is versioned.
	Version interface{}
	// The ID of the Version Set which this API is associated with.
	VersionSetId interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getApi.

func LookupApi added in v0.18.0 

func LookupApi(ctx *pulumi.Context, args *GetApiArgs) (*GetApiResult, error)

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

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/api_management_api.html.markdown.

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 {
	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.
	ExternalId        interface{}
	Name              interface{}
	ResourceGroupName 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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/api_management_group.html.markdown.

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 {
	ApiManagementName interface{}
	// 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{}
	ProductId   interface{}
	// Is this Product Published?
	Published         interface{}
	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{}
	// 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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/api_management_product.html.markdown.

type GetServiceArgs added in v0.18.0 

type GetServiceArgs 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 getService.

type GetServiceResult added in v0.18.0 

type GetServiceResult 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{}
	// Specifies the plan's pricing tier.
	Name 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{}
	ResourceGroupName 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 getService.

func LookupService added in v0.18.0 

func LookupService(ctx *pulumi.Context, args *GetServiceArgs) (*GetServiceResult, error)

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

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/api_management.html.markdown.

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 {
	ApiManagementName interface{}
	// 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{}
	ResourceGroupName interface{}
	// The current state of this User, for example `active`, `blocked` or `pending`.
	State  interface{}
	UserId 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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/api_management_user.html.markdown.

type Group added in v0.17.2 

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

Manages an API Management Group.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_group.html.markdown.

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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_group_user.html.markdown.

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

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

Manages a Logger within an API Management Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_logger.html.markdown.

func GetLogger added in v0.18.0 

func GetLogger(ctx *pulumi.Context,
	name string, id pulumi.ID, state *LoggerState, opts ...pulumi.ResourceOpt) (*Logger, error)

GetLogger gets an existing Logger 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 NewLogger added in v0.18.0 

func NewLogger(ctx *pulumi.Context,
	name string, args *LoggerArgs, opts ...pulumi.ResourceOpt) (*Logger, error)

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

func (*Logger) ApiManagementName added in v0.18.0 

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

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

func (*Logger) ApplicationInsights added in v0.18.0 

func (r *Logger) ApplicationInsights() *pulumi.Output

An `application_insights` block as documented below.

func (*Logger) Buffered added in v0.18.0 

func (r *Logger) Buffered() *pulumi.BoolOutput

Specifies whether records should be buffered in the Logger prior to publishing. Defaults to `true`.

func (*Logger) Description added in v0.18.0 

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

A description of this Logger.

func (*Logger) Eventhub added in v0.18.0 

func (r *Logger) Eventhub() *pulumi.Output

An `eventhub` block as documented below.

func (*Logger) ID added in v0.18.0 

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

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

func (*Logger) Name added in v0.18.0 

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

The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.

func (*Logger) ResourceGroupName added in v0.18.0 

func (r *Logger) 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 (*Logger) URN added in v0.18.0 

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

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

type LoggerArgs added in v0.18.0 

type LoggerArgs struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// An `application_insights` block as documented below.
	ApplicationInsights interface{}
	// Specifies whether records should be buffered in the Logger prior to publishing. Defaults to `true`.
	Buffered interface{}
	// A description of this Logger.
	Description interface{}
	// An `eventhub` block as documented below.
	Eventhub interface{}
	// The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
	Name 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 Logger resource.

type LoggerState added in v0.18.0 

type LoggerState struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// An `application_insights` block as documented below.
	ApplicationInsights interface{}
	// Specifies whether records should be buffered in the Logger prior to publishing. Defaults to `true`.
	Buffered interface{}
	// A description of this Logger.
	Description interface{}
	// An `eventhub` block as documented below.
	Eventhub interface{}
	// The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
	Name 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 Logger resources.

type OpenIdConnectProvider added in v0.18.0 

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

Manages an OpenID Connect Provider within a API Management Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_openid_connect_provider.html.markdown.

func GetOpenIdConnectProvider added in v0.18.0 

func GetOpenIdConnectProvider(ctx *pulumi.Context,
	name string, id pulumi.ID, state *OpenIdConnectProviderState, opts ...pulumi.ResourceOpt) (*OpenIdConnectProvider, error)

GetOpenIdConnectProvider gets an existing OpenIdConnectProvider 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 NewOpenIdConnectProvider added in v0.18.0 

func NewOpenIdConnectProvider(ctx *pulumi.Context,
	name string, args *OpenIdConnectProviderArgs, opts ...pulumi.ResourceOpt) (*OpenIdConnectProvider, error)

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

func (*OpenIdConnectProvider) ApiManagementName added in v0.18.0 

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

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

func (*OpenIdConnectProvider) ClientId added in v0.18.0 

func (r *OpenIdConnectProvider) ClientId() *pulumi.StringOutput

The Client ID used for the Client Application.

func (*OpenIdConnectProvider) ClientSecret added in v0.18.0 

func (r *OpenIdConnectProvider) ClientSecret() *pulumi.StringOutput

The Client Secret used for the Client Application.

func (*OpenIdConnectProvider) Description added in v0.18.0 

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

A description of this OpenID Connect Provider.

func (*OpenIdConnectProvider) DisplayName added in v0.18.0 

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

A user-friendly name for this OpenID Connect Provider.

func (*OpenIdConnectProvider) ID added in v0.18.0 

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

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

func (*OpenIdConnectProvider) MetadataEndpoint added in v0.18.0 

func (r *OpenIdConnectProvider) MetadataEndpoint() *pulumi.StringOutput

The URI of the Metadata endpoint.

func (*OpenIdConnectProvider) Name added in v0.18.0 

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

the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.

func (*OpenIdConnectProvider) ResourceGroupName added in v0.18.0 

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

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

func (*OpenIdConnectProvider) URN added in v0.18.0 

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

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

type OpenIdConnectProviderArgs added in v0.18.0 

type OpenIdConnectProviderArgs struct {
	// The name of the API Management Service in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The Client ID used for the Client Application.
	ClientId interface{}
	// The Client Secret used for the Client Application.
	ClientSecret interface{}
	// A description of this OpenID Connect Provider.
	Description interface{}
	// A user-friendly name for this OpenID Connect Provider.
	DisplayName interface{}
	// The URI of the Metadata endpoint.
	MetadataEndpoint interface{}
	// the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

The set of arguments for constructing a OpenIdConnectProvider resource.

type OpenIdConnectProviderState added in v0.18.0 

type OpenIdConnectProviderState struct {
	// The name of the API Management Service in which this OpenID Connect Provider should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The Client ID used for the Client Application.
	ClientId interface{}
	// The Client Secret used for the Client Application.
	ClientSecret interface{}
	// A description of this OpenID Connect Provider.
	Description interface{}
	// A user-friendly name for this OpenID Connect Provider.
	DisplayName interface{}
	// The URI of the Metadata endpoint.
	MetadataEndpoint interface{}
	// the Name of the OpenID Connect Provider which should be created within the API Management Service. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

Input properties used for looking up and filtering OpenIdConnectProvider resources.

type Product added in v0.17.2 

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

Manages an API Management Product.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_product.html.markdown.

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

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

Manages an API Management API Assignment to a Product.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_product_api.html.markdown.

func GetProductApi added in v0.18.0 

func GetProductApi(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ProductApiState, opts ...pulumi.ResourceOpt) (*ProductApi, error)

GetProductApi gets an existing ProductApi 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 NewProductApi added in v0.18.0 

func NewProductApi(ctx *pulumi.Context,
	name string, args *ProductApiArgs, opts ...pulumi.ResourceOpt) (*ProductApi, error)

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

func (*ProductApi) ApiManagementName added in v0.18.0 

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

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

func (*ProductApi) ApiName added in v0.18.0 

func (r *ProductApi) ApiName() *pulumi.StringOutput

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

func (*ProductApi) ID added in v0.18.0 

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

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

func (*ProductApi) ProductId added in v0.18.0 

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

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

func (*ProductApi) ResourceGroupName added in v0.18.0 

func (r *ProductApi) 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 (*ProductApi) URN added in v0.18.0 

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

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

type ProductApiArgs added in v0.18.0 

type ProductApiArgs 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 API within the API Management Service. Changing this forces a new resource to be created.
	ApiName interface{}
	// The ID of the API Management Product within the API Management Service. Changing this forces a new resource to be created.
	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 ProductApi resource.

type ProductApiState added in v0.18.0 

type ProductApiState 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 API within the API Management Service. Changing this forces a new resource to be created.
	ApiName interface{}
	// The ID of the API Management Product within the API Management Service. Changing this forces a new resource to be created.
	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 ProductApi resources.

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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_product_group.html.markdown.

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

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

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{}
	// The ID of the API Management Product within the API Management Service. Changing this forces a new resource to be created.
	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{}
	// The ID of the API Management Product within the API Management Service. Changing this forces a new resource to be created.
	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 ProductPolicy added in v0.18.3 

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

Manages an API Management Product Policy

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_product_policy.html.markdown.

func GetProductPolicy added in v0.18.3 

func GetProductPolicy(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ProductPolicyState, opts ...pulumi.ResourceOpt) (*ProductPolicy, error)

GetProductPolicy gets an existing ProductPolicy 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 NewProductPolicy added in v0.18.3 

func NewProductPolicy(ctx *pulumi.Context,
	name string, args *ProductPolicyArgs, opts ...pulumi.ResourceOpt) (*ProductPolicy, error)

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

func (*ProductPolicy) ApiManagementName added in v0.18.3 

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

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

func (*ProductPolicy) ID added in v0.18.3 

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

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

func (*ProductPolicy) ProductId added in v0.18.3 

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

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

func (*ProductPolicy) ResourceGroupName added in v0.18.3 

func (r *ProductPolicy) 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 (*ProductPolicy) URN added in v0.18.3 

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

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

func (*ProductPolicy) XmlContent added in v0.18.3 

func (r *ProductPolicy) XmlContent() *pulumi.StringOutput

The XML Content for this Policy. 

func (r *ProductPolicy) XmlLink() *pulumi.StringOutput

A link to a Policy XML Document, which must be publicly available.

type ProductPolicyArgs added in v0.18.3 

type ProductPolicyArgs struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The ID of the API Management Product within the API Management Service. Changing this forces a new resource to be created.
	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 XML Content for this Policy.
	XmlContent interface{}
	// A link to a Policy XML Document, which must be publicly available.
	XmlLink interface{}
}

The set of arguments for constructing a ProductPolicy resource.

type ProductPolicyState added in v0.18.3 

type ProductPolicyState struct {
	// The name of the API Management Service. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The ID of the API Management Product within the API Management Service. Changing this forces a new resource to be created.
	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 XML Content for this Policy.
	XmlContent interface{}
	// A link to a Policy XML Document, which must be publicly available.
	XmlLink interface{}
}

Input properties used for looking up and filtering ProductPolicy 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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_property.html.markdown.

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

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

Manages an API Management Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management.html.markdown.

func GetService added in v0.18.0 

func GetService(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ServiceState, opts ...pulumi.ResourceOpt) (*Service, error)

GetService gets an existing Service 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 NewService added in v0.18.0 

func NewService(ctx *pulumi.Context,
	name string, args *ServiceArgs, opts ...pulumi.ResourceOpt) (*Service, error)

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

func (*Service) AdditionalLocation added in v0.18.0 

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

One or more `additional_location` blocks as defined below.

func (*Service) Certificates added in v0.18.0 

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

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

func (*Service) GatewayRegionalUrl added in v0.18.0 

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

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

func (*Service) GatewayUrl added in v0.18.0 

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

The URL of the Gateway for the API Management Service.

func (*Service) HostnameConfiguration added in v0.18.0 

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

A `hostname_configuration` block as defined below.

func (*Service) ID added in v0.18.0 

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

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

func (*Service) Identity added in v0.18.0 

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

An `identity` block is documented below.

func (*Service) Location added in v0.18.0 

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

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

func (*Service) ManagementApiUrl added in v0.18.0 

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

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

func (*Service) Name added in v0.18.0 

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

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

func (*Service) NotificationSenderEmail added in v0.18.0 

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

Email address from which the notification will be sent.

func (*Service) Policy added in v0.18.0 

func (r *Service) Policy() *pulumi.Output

A `policy` block as defined below.

func (*Service) PortalUrl added in v0.18.0 

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

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

func (*Service) PublicIpAddresses added in v0.18.0 

func (r *Service) 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 (*Service) PublisherEmail added in v0.18.0 

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

The email of publisher/company.

func (*Service) PublisherName added in v0.18.0 

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

The name of publisher/company.

func (*Service) ResourceGroupName added in v0.18.0 

func (r *Service) 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 (*Service) ScmUrl added in v0.18.0 

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

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

func (*Service) Security added in v0.18.0 

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

A `security` block as defined below.

func (*Service) SignIn added in v0.18.0 

func (r *Service) SignIn() *pulumi.Output

A `sign_in` block as defined below.

func (*Service) SignUp added in v0.18.0 

func (r *Service) SignUp() *pulumi.Output

A `sign_up` block as defined below.

func (*Service) Sku added in v0.18.0 

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

A `sku` block as documented below.

func (*Service) Tags added in v0.18.0 

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

A mapping of tags assigned to the resource.

func (*Service) URN added in v0.18.0 

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

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

type ServiceArgs added in v0.18.0 

type ServiceArgs 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{}
	// A `policy` block as defined below.
	Policy 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 `sign_in` block as defined below.
	SignIn interface{}
	// A `sign_up` block as defined below.
	SignUp 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 Service resource.

type ServiceState added in v0.18.0 

type ServiceState 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{}
	// A `policy` block as defined below.
	Policy 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 `sign_in` block as defined below.
	SignIn interface{}
	// A `sign_up` block as defined below.
	SignUp 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 Service resources.

type Subscription added in v0.18.0 

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

Manages a Subscription within a API Management Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_subscription.html.markdown.

func GetSubscription added in v0.18.0 

func GetSubscription(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SubscriptionState, opts ...pulumi.ResourceOpt) (*Subscription, error)

GetSubscription gets an existing Subscription 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 NewSubscription added in v0.18.0 

func NewSubscription(ctx *pulumi.Context,
	name string, args *SubscriptionArgs, opts ...pulumi.ResourceOpt) (*Subscription, error)

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

func (*Subscription) ApiManagementName added in v0.18.0 

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

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

func (*Subscription) DisplayName added in v0.18.0 

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

The display name of this Subscription.

func (*Subscription) ID added in v0.18.0 

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

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

func (*Subscription) PrimaryKey added in v0.18.0 

func (r *Subscription) PrimaryKey() *pulumi.StringOutput

func (*Subscription) ProductId added in v0.18.0 

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

The ID of the Product which should be assigned to this Subscription. Changing this forces a new resource to be created.

func (*Subscription) ResourceGroupName added in v0.18.0 

func (r *Subscription) 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 (*Subscription) SecondaryKey added in v0.18.0 

func (r *Subscription) SecondaryKey() *pulumi.StringOutput

func (*Subscription) State added in v0.18.0 

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

The state of this Subscription. Possible values are `Active`, `Cancelled`, `Expired`, `Rejected`, `Submitted` and `Suspended`. Defaults to `Submitted`.

func (*Subscription) SubscriptionId added in v0.18.0 

func (r *Subscription) SubscriptionId() *pulumi.StringOutput

An Identifier which should used as the ID of this Subscription. If not specified a new Subscription ID will be generated. Changing this forces a new resource to be created.

func (*Subscription) URN added in v0.18.0 

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

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

func (*Subscription) UserId added in v0.18.0 

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

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

type SubscriptionArgs added in v0.18.0 

type SubscriptionArgs struct {
	// The name of the API Management Service where this Subscription should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The display name of this Subscription.
	DisplayName interface{}
	PrimaryKey  interface{}
	// The ID of the Product which should be assigned to this Subscription. Changing this forces a new resource to be created.
	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{}
	SecondaryKey      interface{}
	// The state of this Subscription. Possible values are `Active`, `Cancelled`, `Expired`, `Rejected`, `Submitted` and `Suspended`. Defaults to `Submitted`.
	State interface{}
	// An Identifier which should used as the ID of this Subscription. If not specified a new Subscription ID will be generated. Changing this forces a new resource to be created.
	SubscriptionId interface{}
	// The ID of the User which should be assigned to this Subscription. Changing this forces a new resource to be created.
	UserId interface{}
}

The set of arguments for constructing a Subscription resource.

type SubscriptionState added in v0.18.0 

type SubscriptionState struct {
	// The name of the API Management Service where this Subscription should be created. Changing this forces a new resource to be created.
	ApiManagementName interface{}
	// The display name of this Subscription.
	DisplayName interface{}
	PrimaryKey  interface{}
	// The ID of the Product which should be assigned to this Subscription. Changing this forces a new resource to be created.
	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{}
	SecondaryKey      interface{}
	// The state of this Subscription. Possible values are `Active`, `Cancelled`, `Expired`, `Rejected`, `Submitted` and `Suspended`. Defaults to `Submitted`.
	State interface{}
	// An Identifier which should used as the ID of this Subscription. If not specified a new Subscription ID will be generated. Changing this forces a new resource to be created.
	SubscriptionId interface{}
	// The ID of the User which should be assigned to this Subscription. Changing this forces a new resource to be created.
	UserId interface{}
}

Input properties used for looking up and filtering Subscription resources.

type User added in v0.17.2 

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

Manages an API Management User.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/api_management_user.html.markdown.

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.