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.

pulumi_azure.apimanagement.get_api(name=None, resource_group_name=None)

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