apimanagement

class pulumi_azure.apimanagement.API(resource_name, opts=None, additional_location=None, certificates=None, hostname_configuration=None, identity=None, location=None, name=None, notification_sender_email=None, publisher_email=None, publisher_name=None, resource_group_name=None, security=None, sku=None, tags=None, __name__=None, __opts__=None)

Manages an API Management Service.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • additional_location (pulumi.Input[dict]) – One or more additional_location blocks as defined below.
  • certificates (pulumi.Input[list]) – One or more (up to 10) certificate blocks as defined below.
  • hostname_configuration (pulumi.Input[dict]) – A hostname_configuration block as defined below.
  • identity (pulumi.Input[dict]) – An identity block is documented below.
  • location (pulumi.Input[str]) – The Azure location where the API Management Service exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the API Management Service. Changing this forces a new resource to be created.
  • notification_sender_email (pulumi.Input[str]) – Email address from which the notification will be sent.
  • publisher_email (pulumi.Input[str]) – The email of publisher/company.
  • publisher_name (pulumi.Input[str]) – The name of publisher/company.
  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
  • security (pulumi.Input[dict]) – A security block as defined below.
  • sku (pulumi.Input[dict]) – A sku block as documented below.
  • tags (pulumi.Input[dict]) – A mapping of tags assigned to the resource.
additional_location = None

One or more additional_location blocks as defined below.

certificates = None

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

gateway_regional_url = None

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

gateway_url = None

The URL of the Gateway for the API Management Service.

hostname_configuration = None

A hostname_configuration block as defined below.

identity = None

An identity block is documented below.

location = None

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

management_api_url = None

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

name = None

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

notification_sender_email = None

Email address from which the notification will be sent.

portal_url = None

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

public_ip_addresses = None

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

publisher_email = None

The email of publisher/company.

publisher_name = None

The name of publisher/company.

resource_group_name = None

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

scm_url = None

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

security = None

A security block as defined below.

sku = None

A sku block as documented below.

tags = None

A mapping of tags assigned to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.apimanagement.GetAPIResult(additional_locations=None, gateway_regional_url=None, gateway_url=None, hostname_configurations=None, location=None, management_api_url=None, notification_sender_email=None, portal_url=None, public_ip_addresses=None, publisher_email=None, publisher_name=None, scm_url=None, sku=None, tags=None, id=None)

A collection of values returned by getAPI.

additional_locations = None

One or more additional_location blocks as defined below

gateway_regional_url = None

Gateway URL of the API Management service in the Region.

gateway_url = None

The URL for the API Management Service’s Gateway.

hostname_configurations = None

A hostname_configuration block as defined below.

location = None

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

management_api_url = None

The URL for the Management API.

notification_sender_email = None

The email address from which the notification will be sent.

portal_url = None

The URL of the Publisher Portal.

public_ip_addresses = None

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

publisher_email = None

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

publisher_name = None

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

scm_url = None

The SCM (Source Code Management) endpoint.

sku = None

A sku block as documented below.

tags = None

A mapping of tags assigned to the resource.

id = None

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

class pulumi_azure.apimanagement.GetGroupResult(description=None, display_name=None, external_id=None, type=None, id=None)

A collection of values returned by getGroup.

description = None

The description of this API Management Group.

display_name = None

The display name of this API Management Group.

external_id = None

The identifier of the external Group.

type = None

The type of this API Management Group, such as custom or external.

id = None

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

class pulumi_azure.apimanagement.GetProductResult(approval_required=None, description=None, display_name=None, published=None, subscription_required=None, subscriptions_limit=None, terms=None, id=None)

A collection of values returned by getProduct.

approval_required = None

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

description = None

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

display_name = None

The Display Name for this API Management Product.

published = None

Is this Product Published?

subscription_required = None

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

subscriptions_limit = None

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

terms = None

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

id = None

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

class pulumi_azure.apimanagement.GetUserResult(email=None, first_name=None, last_name=None, note=None, state=None, id=None)

A collection of values returned by getUser.

email = None

The Email Address used for this User.

first_name = None

The First Name for the User.

last_name = None

The Last Name for the User.

note = None

Any notes about this User.

state = None

The current state of this User, for example active, blocked or pending.

id = None

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

class pulumi_azure.apimanagement.Group(resource_name, opts=None, api_management_name=None, description=None, display_name=None, external_id=None, name=None, resource_group_name=None, type=None, __name__=None, __opts__=None)

Manages an API Management Group.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • api_management_name (pulumi.Input[str]) – The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
  • description (pulumi.Input[str]) – The description of this API Management Group.
  • display_name (pulumi.Input[str]) – The display name of this API Management Group.
  • external_id (pulumi.Input[str]) – The identifier of the external Group. For example, an Azure Active Directory group aad://<tenant>.onmicrosoft.com/groups/<group object id>.
  • name (pulumi.Input[str]) – The name of the API Management Group. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
  • type (pulumi.Input[str]) – The type of this API Management Group. Possible values are custom and external. Default is custom.
api_management_name = None

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

description = None

The description of this API Management Group.

display_name = None

The display name of this API Management Group.

external_id = None

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

name = None

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

resource_group_name = None

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

type = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.apimanagement.GroupUser(resource_name, opts=None, api_management_name=None, group_name=None, resource_group_name=None, user_id=None, __name__=None, __opts__=None)

Manages an API Management User Assignment to a Group.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • api_management_name (pulumi.Input[str]) – The name of the API Management Service. Changing this forces a new resource to be created.
  • group_name (pulumi.Input[str]) – The Name of the API Management Group within the API Management Service. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
  • user_id (pulumi.Input[str]) – 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.
api_management_name = None

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

group_name = None

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

resource_group_name = None

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

user_id = None

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.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.apimanagement.Product(resource_name, opts=None, api_management_name=None, approval_required=None, description=None, display_name=None, product_id=None, published=None, resource_group_name=None, subscription_required=None, subscriptions_limit=None, terms=None, __name__=None, __opts__=None)

Manages an API Management Product.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • api_management_name (pulumi.Input[str]) – The name of the API Management Service. Changing this forces a new resource to be created.
  • approval_required (pulumi.Input[bool]) – Do subscribers need to be approved prior to being able to use the Product?
  • description (pulumi.Input[str]) – A description of this Product, which may include HTML formatting tags.
  • display_name (pulumi.Input[str]) – The Display Name for this API Management Product.
  • product_id (pulumi.Input[str]) – The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
  • published (pulumi.Input[bool]) – Is this Product Published?
  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
  • subscription_required (pulumi.Input[bool]) – Is a Subscription required to access API’s included in this Product?
  • subscriptions_limit (pulumi.Input[float]) – The number of subscriptions a user can have to this Product at the same time.
  • terms (pulumi.Input[str]) – The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
api_management_name = None

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

approval_required = None

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

description = None

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

display_name = None

The Display Name for this API Management Product.

product_id = None

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

published = None

Is this Product Published?

resource_group_name = None

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

subscription_required = None

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

subscriptions_limit = None

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

terms = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.apimanagement.ProductGroup(resource_name, opts=None, api_management_name=None, group_name=None, product_id=None, resource_group_name=None, __name__=None, __opts__=None)

Manages an API Management Product Assignment to a Group.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • api_management_name (pulumi.Input[str]) – The name of the API Management Service. Changing this forces a new resource to be created.
  • group_name (pulumi.Input[str]) – The Name of the API Management Group within the API Management Service. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
api_management_name = None

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

group_name = None

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

resource_group_name = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.apimanagement.Property(resource_name, opts=None, api_management_name=None, display_name=None, name=None, resource_group_name=None, secret=None, tags=None, value=None, __name__=None, __opts__=None)

Manages an API Management Property.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • api_management_name (pulumi.Input[str]) – The name of the API Management Service in which the API Management Property should exist. Changing this forces a new resource to be created.
  • display_name (pulumi.Input[str]) – The display name of this API Management Property.
  • name (pulumi.Input[str]) – The name of the API Management Property. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the API Management Property should exist. Changing this forces a new resource to be created.
  • secret (pulumi.Input[bool]) – Specifies whether the API Management Property is secret. Valid values are true or false. The default value is false.
  • tags (pulumi.Input[list]) – A list of tags to be applied to the API Management Property.
  • value (pulumi.Input[str]) – The value of this API Management Property.
api_management_name = None

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

display_name = None

The display name of this API Management Property.

name = None

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

resource_group_name = None

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

secret = None

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

tags = None

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

value = None

The value of this API Management Property.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.apimanagement.User(resource_name, opts=None, api_management_name=None, confirmation=None, email=None, first_name=None, last_name=None, note=None, password=None, resource_group_name=None, state=None, user_id=None, __name__=None, __opts__=None)

Manages an API Management User.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • api_management_name (pulumi.Input[str]) – The name of the API Management Service in which the User should be created. Changing this forces a new resource to be created.
  • confirmation (pulumi.Input[str]) – 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.
  • email (pulumi.Input[str]) – The email address associated with this user.
  • first_name (pulumi.Input[str]) – The first name for this user.
  • last_name (pulumi.Input[str]) – The last name for this user.
  • note (pulumi.Input[str]) – A note about this user.
  • password (pulumi.Input[str]) – The password associated with this user.
  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
  • state (pulumi.Input[str]) – The state of this user. Possible values are active, blocked and pending.
  • user_id (pulumi.Input[str]) – The Identifier for this User, which must be unique within the API Management Service. Changing this forces a new resource to be created.
api_management_name = None

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

confirmation = None

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.

email = None

The email address associated with this user.

first_name = None

The first name for this user.

last_name = None

The last name for this user.

note = None

A note about this user.

password = None

The password associated with this user.

resource_group_name = None

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

state = None

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

user_id = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_azure.apimanagement.get_api(name=None, resource_group_name=None, opts=None)

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

pulumi_azure.apimanagement.get_group(api_management_name=None, name=None, resource_group_name=None, opts=None)

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

pulumi_azure.apimanagement.get_product(api_management_name=None, product_id=None, resource_group_name=None, opts=None)

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

pulumi_azure.apimanagement.get_user(api_management_name=None, resource_group_name=None, user_id=None, opts=None)

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