This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

apimanagement

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.apimanagement.Api(resource_name, opts=None, api_management_name=None, description=None, display_name=None, import_=None, name=None, path=None, protocols=None, resource_group_name=None, revision=None, service_url=None, soap_pass_through=None, subscription_key_parameter_names=None, version=None, version_set_id=None, __props__=None, __name__=None, __opts__=None)

Manages an API within an API Management Service.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
example_api = azure.apimanagement.Api("exampleApi",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    revision="1",
    display_name="Example API",
    path="example",
    protocols=["https"],
    import_={
        "contentFormat": "swagger-link-json",
        "contentValue": "http://conferenceapi.azurewebsites.net/?format=json",
    })
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 where this API should be created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – A description of the API Management API, which may include HTML formatting tags.

  • display*name (pulumi.Input[str]) –

    The display name of the API.

:param pulumi.Input[dict] import*: A import block as documented below. :param pulumi.Input[str] name: The name of the API Management API. Changing this forces a new resource to be created. :param pulumi.Input[str] path: 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. :param pulumi.Input[list] protocols: A list of protocols the operations in this API can be invoked. Possible values are http and https. :param pulumi.Input[str] resource_group_name: The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created. :param pulumi.Input[str] revision: The Revision which used for this API. :param pulumi.Input[str] service_url: Absolute URL of the backend service implementing this API. :param pulumi.Input[bool] soap_pass_through: Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to false. :param pulumi.Input[dict] subscription_key_parameter_names: A subscription_key_parameter_names block as documented below. :param pulumi.Input[str] version: The Version number of this API, if this API is versioned. :param pulumi.Input[str] version_set_id: The ID of the Version Set which this API is associated with.

The import_ object supports the following:

  • contentFormat (pulumi.Input[str]) - The format of the content from which the API Definition should be imported. Possible values are: openapi, openapi+json, openapi+json-link, openapi-link, swagger-json, swagger-link-json, wadl-link-json, wadl-xml, wsdl and wsdl-link.

  • contentValue (pulumi.Input[str]) - The Content from which the API Definition should be imported. When a content_format of *-link-* is specified this must be a URL, otherwise this must be defined inline.

  • wsdlSelector (pulumi.Input[dict]) - A wsdl_selector block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified when content_format is wsdl or wsdl-link.

    • endpointName (pulumi.Input[str]) - The name of endpoint (port) to import from WSDL.

    • service_name (pulumi.Input[str]) - The name of service to import from WSDL.

The subscription_key_parameter_names object supports the following:

  • header (pulumi.Input[str]) - The name of the HTTP Header which should be used for the Subscription Key.

  • query (pulumi.Input[str]) - The name of the QueryString parameter which should be used for the Subscription Key.

api_management_name: pulumi.Output[str] = None

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

description: pulumi.Output[str] = None

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

display_name: pulumi.Output[str] = None

The display name of the API.

import_: pulumi.Output[dict] = None

A import block as documented below.

  • contentFormat (str) - The format of the content from which the API Definition should be imported. Possible values are: openapi, openapi+json, openapi+json-link, openapi-link, swagger-json, swagger-link-json, wadl-link-json, wadl-xml, wsdl and wsdl-link.

  • contentValue (str) - The Content from which the API Definition should be imported. When a content_format of *-link-* is specified this must be a URL, otherwise this must be defined inline.

  • wsdlSelector (dict) - A wsdl_selector block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified when content_format is wsdl or wsdl-link.

    • endpointName (str) - The name of endpoint (port) to import from WSDL.

    • service_name (str) - The name of service to import from WSDL.

is_current: pulumi.Output[bool] = None

Is this the current API Revision?

is_online: pulumi.Output[bool] = None

Is this API Revision online/accessible via the Gateway?

name: pulumi.Output[str] = None

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

path: pulumi.Output[str] = None

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.

protocols: pulumi.Output[list] = None

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

resource_group_name: pulumi.Output[str] = None

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

revision: pulumi.Output[str] = None

The Revision which used for this API.

service_url: pulumi.Output[str] = None

Absolute URL of the backend service implementing this API.

soap_pass_through: pulumi.Output[bool] = None

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

subscription_key_parameter_names: pulumi.Output[dict] = None

A subscription_key_parameter_names block as documented below.

  • header (str) - The name of the HTTP Header which should be used for the Subscription Key.

  • query (str) - The name of the QueryString parameter which should be used for the Subscription Key.

version: pulumi.Output[str] = None

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

version_set_id: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, description=None, display_name=None, import_=None, is_current=None, is_online=None, name=None, path=None, protocols=None, resource_group_name=None, revision=None, service_url=None, soap_pass_through=None, subscription_key_parameter_names=None, version=None, version_set_id=None)

Get an existing Api resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – A description of the API Management API, which may include HTML formatting tags.

  • display*name (pulumi.Input[str]) –

    The display name of the API.

:param pulumi.Input[dict] import*: A import block as documented below. :param pulumi.Input[bool] is_current: Is this the current API Revision? :param pulumi.Input[bool] is_online: Is this API Revision online/accessible via the Gateway? :param pulumi.Input[str] name: The name of the API Management API. Changing this forces a new resource to be created. :param pulumi.Input[str] path: 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. :param pulumi.Input[list] protocols: A list of protocols the operations in this API can be invoked. Possible values are http and https. :param pulumi.Input[str] resource_group_name: The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created. :param pulumi.Input[str] revision: The Revision which used for this API. :param pulumi.Input[str] service_url: Absolute URL of the backend service implementing this API. :param pulumi.Input[bool] soap_pass_through: Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to false. :param pulumi.Input[dict] subscription_key_parameter_names: A subscription_key_parameter_names block as documented below. :param pulumi.Input[str] version: The Version number of this API, if this API is versioned. :param pulumi.Input[str] version_set_id: The ID of the Version Set which this API is associated with.

The import_ object supports the following:

  • contentFormat (pulumi.Input[str]) - The format of the content from which the API Definition should be imported. Possible values are: openapi, openapi+json, openapi+json-link, openapi-link, swagger-json, swagger-link-json, wadl-link-json, wadl-xml, wsdl and wsdl-link.

  • contentValue (pulumi.Input[str]) - The Content from which the API Definition should be imported. When a content_format of *-link-* is specified this must be a URL, otherwise this must be defined inline.

  • wsdlSelector (pulumi.Input[dict]) - A wsdl_selector block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified when content_format is wsdl or wsdl-link.

    • endpointName (pulumi.Input[str]) - The name of endpoint (port) to import from WSDL.

    • service_name (pulumi.Input[str]) - The name of service to import from WSDL.

The subscription_key_parameter_names object supports the following:

  • header (pulumi.Input[str]) - The name of the HTTP Header which should be used for the Subscription Key.

  • query (pulumi.Input[str]) - The name of the QueryString parameter which should be used for the Subscription Key.

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.ApiOperation(resource_name, opts=None, api_management_name=None, api_name=None, description=None, display_name=None, method=None, operation_id=None, request=None, resource_group_name=None, responses=None, template_parameters=None, url_template=None, __props__=None, __name__=None, __opts__=None)

Manages an API Operation within an API Management Service.

import pulumi
import pulumi_azure as azure

example_api = azure.apimanagement.get_api(name="search-api",
    api_management_name="search-api-management",
    resource_group_name="search-service",
    revision="2")
example_api_operation = azure.apimanagement.ApiOperation("exampleApiOperation",
    operation_id="user-delete",
    api_name=example_api.name,
    api_management_name=example_api.api_management_name,
    resource_group_name=example_api.resource_group_name,
    display_name="Delete User Operation",
    method="DELETE",
    url_template="/users/{id}/delete",
    description="This can only be done by the logged in user.",
    response=[{
        "statusCode": 200,
    }])
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 where the API exists. Changing this forces a new resource to be created.

  • api_name (pulumi.Input[str]) – 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.

  • description (pulumi.Input[str]) – A description for this API Operation, which may include HTML formatting tags.

  • display_name (pulumi.Input[str]) – The Display Name for this API Management Operation.

  • method (pulumi.Input[str]) – The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.

  • operation_id (pulumi.Input[str]) – A unique identifier for this API Operation. Changing this forces a new resource to be created.

  • request (pulumi.Input[dict]) – A request block as defined below.

  • 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.

  • responses (pulumi.Input[list]) – One or more response blocks as defined below.

  • template_parameters (pulumi.Input[list]) – One or more template_parameter blocks as defined below.

  • url_template (pulumi.Input[str]) – The relative URL Template identifying the target resource for this operation, which may include parameters.

The request object supports the following:

  • description (pulumi.Input[str]) - A description of the HTTP Request, which may include HTML tags.

  • headers (pulumi.Input[list]) - One or more header blocks as defined above.

    • defaultValue (pulumi.Input[str]) - The default value for this Header.

    • description (pulumi.Input[str]) - A description of this Header.

    • name (pulumi.Input[str]) - The Name of this Header.

    • required (pulumi.Input[bool]) - Is this Header Required?

    • type (pulumi.Input[str]) - The Type of this Header, such as a string.

    • values (pulumi.Input[list]) - One or more acceptable values for this Header.

  • queryParameters (pulumi.Input[list]) - One or more query_parameter blocks as defined above.

    • defaultValue (pulumi.Input[str]) - The default value for this Query Parameter.

    • description (pulumi.Input[str]) - A description of this Query Parameter.

    • name (pulumi.Input[str]) - The Name of this Query Parameter.

    • required (pulumi.Input[bool]) - Is this Query Parameter Required?

    • type (pulumi.Input[str]) - The Type of this Query Parameter, such as a string.

    • values (pulumi.Input[list]) - One or more acceptable values for this Query Parameter.

  • representations (pulumi.Input[list]) - One or more representation blocks as defined below.

    • content_type (pulumi.Input[str]) - The Content Type of this representation, such as application/json.

    • formParameters (pulumi.Input[list]) - One or more form_parameter block as defined above.

      • defaultValue (pulumi.Input[str]) - The default value for this Form Parameter.

      • description (pulumi.Input[str]) - A description of this Form Parameter.

      • name (pulumi.Input[str]) - The Name of this Form Parameter.

      • required (pulumi.Input[bool]) - Is this Form Parameter Required?

      • type (pulumi.Input[str]) - The Type of this Form Parameter, such as a string.

      • values (pulumi.Input[list]) - One or more acceptable values for this Form Parameter.

    • sample (pulumi.Input[str]) - An example of this representation.

    • schema_id (pulumi.Input[str]) - The ID of an API Management Schema which represents this Response.

    • typeName (pulumi.Input[str]) - The Type Name defined by the Schema.

The responses object supports the following:

  • description (pulumi.Input[str]) - A description of the HTTP Response, which may include HTML tags.

  • headers (pulumi.Input[list]) - One or more header blocks as defined above.

    • defaultValue (pulumi.Input[str]) - The default value for this Header.

    • description (pulumi.Input[str]) - A description of this Header.

    • name (pulumi.Input[str]) - The Name of this Header.

    • required (pulumi.Input[bool]) - Is this Header Required?

    • type (pulumi.Input[str]) - The Type of this Header, such as a string.

    • values (pulumi.Input[list]) - One or more acceptable values for this Header.

  • representations (pulumi.Input[list]) - One or more representation blocks as defined below.

    • content_type (pulumi.Input[str]) - The Content Type of this representation, such as application/json.

    • formParameters (pulumi.Input[list]) - One or more form_parameter block as defined above.

      • defaultValue (pulumi.Input[str]) - The default value for this Form Parameter.

      • description (pulumi.Input[str]) - A description of this Form Parameter.

      • name (pulumi.Input[str]) - The Name of this Form Parameter.

      • required (pulumi.Input[bool]) - Is this Form Parameter Required?

      • type (pulumi.Input[str]) - The Type of this Form Parameter, such as a string.

      • values (pulumi.Input[list]) - One or more acceptable values for this Form Parameter.

    • sample (pulumi.Input[str]) - An example of this representation.

    • schema_id (pulumi.Input[str]) - The ID of an API Management Schema which represents this Response.

    • typeName (pulumi.Input[str]) - The Type Name defined by the Schema.

  • statusCode (pulumi.Input[float]) - The HTTP Status Code.

The template_parameters object supports the following:

  • defaultValue (pulumi.Input[str]) - The default value for this Template Parameter.

  • description (pulumi.Input[str]) - A description of this Template Parameter.

  • name (pulumi.Input[str]) - The Name of this Template Parameter.

  • required (pulumi.Input[bool]) - Is this Template Parameter Required?

  • type (pulumi.Input[str]) - The Type of this Template Parameter, such as a string.

  • values (pulumi.Input[list]) - One or more acceptable values for this Template Parameter.

api_management_name: pulumi.Output[str] = None

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

api_name: pulumi.Output[str] = None

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.

description: pulumi.Output[str] = None

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

display_name: pulumi.Output[str] = None

The Display Name for this API Management Operation.

method: pulumi.Output[str] = None

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

operation_id: pulumi.Output[str] = None

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

request: pulumi.Output[dict] = None

A request block as defined below.

  • description (str) - A description of the HTTP Request, which may include HTML tags.

  • headers (list) - One or more header blocks as defined above.

    • defaultValue (str) - The default value for this Header.

    • description (str) - A description of this Header.

    • name (str) - The Name of this Header.

    • required (bool) - Is this Header Required?

    • type (str) - The Type of this Header, such as a string.

    • values (list) - One or more acceptable values for this Header.

  • queryParameters (list) - One or more query_parameter blocks as defined above.

    • defaultValue (str) - The default value for this Query Parameter.

    • description (str) - A description of this Query Parameter.

    • name (str) - The Name of this Query Parameter.

    • required (bool) - Is this Query Parameter Required?

    • type (str) - The Type of this Query Parameter, such as a string.

    • values (list) - One or more acceptable values for this Query Parameter.

  • representations (list) - One or more representation blocks as defined below.

    • content_type (str) - The Content Type of this representation, such as application/json.

    • formParameters (list) - One or more form_parameter block as defined above.

      • defaultValue (str) - The default value for this Form Parameter.

      • description (str) - A description of this Form Parameter.

      • name (str) - The Name of this Form Parameter.

      • required (bool) - Is this Form Parameter Required?

      • type (str) - The Type of this Form Parameter, such as a string.

      • values (list) - One or more acceptable values for this Form Parameter.

    • sample (str) - An example of this representation.

    • schema_id (str) - The ID of an API Management Schema which represents this Response.

    • typeName (str) - The Type Name defined by the Schema.

resource_group_name: pulumi.Output[str] = None

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

responses: pulumi.Output[list] = None

One or more response blocks as defined below.

  • description (str) - A description of the HTTP Response, which may include HTML tags.

  • headers (list) - One or more header blocks as defined above.

    • defaultValue (str) - The default value for this Header.

    • description (str) - A description of this Header.

    • name (str) - The Name of this Header.

    • required (bool) - Is this Header Required?

    • type (str) - The Type of this Header, such as a string.

    • values (list) - One or more acceptable values for this Header.

  • representations (list) - One or more representation blocks as defined below.

    • content_type (str) - The Content Type of this representation, such as application/json.

    • formParameters (list) - One or more form_parameter block as defined above.

      • defaultValue (str) - The default value for this Form Parameter.

      • description (str) - A description of this Form Parameter.

      • name (str) - The Name of this Form Parameter.

      • required (bool) - Is this Form Parameter Required?

      • type (str) - The Type of this Form Parameter, such as a string.

      • values (list) - One or more acceptable values for this Form Parameter.

    • sample (str) - An example of this representation.

    • schema_id (str) - The ID of an API Management Schema which represents this Response.

    • typeName (str) - The Type Name defined by the Schema.

  • statusCode (float) - The HTTP Status Code.

template_parameters: pulumi.Output[list] = None

One or more template_parameter blocks as defined below.

  • defaultValue (str) - The default value for this Template Parameter.

  • description (str) - A description of this Template Parameter.

  • name (str) - The Name of this Template Parameter.

  • required (bool) - Is this Template Parameter Required?

  • type (str) - The Type of this Template Parameter, such as a string.

  • values (list) - One or more acceptable values for this Template Parameter.

url_template: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, api_name=None, description=None, display_name=None, method=None, operation_id=None, request=None, resource_group_name=None, responses=None, template_parameters=None, url_template=None)

Get an existing ApiOperation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.

  • api_name (pulumi.Input[str]) – 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.

  • description (pulumi.Input[str]) – A description for this API Operation, which may include HTML formatting tags.

  • display_name (pulumi.Input[str]) – The Display Name for this API Management Operation.

  • method (pulumi.Input[str]) – The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.

  • operation_id (pulumi.Input[str]) – A unique identifier for this API Operation. Changing this forces a new resource to be created.

  • request (pulumi.Input[dict]) – A request block as defined below.

  • 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.

  • responses (pulumi.Input[list]) – One or more response blocks as defined below.

  • template_parameters (pulumi.Input[list]) – One or more template_parameter blocks as defined below.

  • url_template (pulumi.Input[str]) – The relative URL Template identifying the target resource for this operation, which may include parameters.

The request object supports the following:

  • description (pulumi.Input[str]) - A description of the HTTP Request, which may include HTML tags.

  • headers (pulumi.Input[list]) - One or more header blocks as defined above.

    • defaultValue (pulumi.Input[str]) - The default value for this Header.

    • description (pulumi.Input[str]) - A description of this Header.

    • name (pulumi.Input[str]) - The Name of this Header.

    • required (pulumi.Input[bool]) - Is this Header Required?

    • type (pulumi.Input[str]) - The Type of this Header, such as a string.

    • values (pulumi.Input[list]) - One or more acceptable values for this Header.

  • queryParameters (pulumi.Input[list]) - One or more query_parameter blocks as defined above.

    • defaultValue (pulumi.Input[str]) - The default value for this Query Parameter.

    • description (pulumi.Input[str]) - A description of this Query Parameter.

    • name (pulumi.Input[str]) - The Name of this Query Parameter.

    • required (pulumi.Input[bool]) - Is this Query Parameter Required?

    • type (pulumi.Input[str]) - The Type of this Query Parameter, such as a string.

    • values (pulumi.Input[list]) - One or more acceptable values for this Query Parameter.

  • representations (pulumi.Input[list]) - One or more representation blocks as defined below.

    • content_type (pulumi.Input[str]) - The Content Type of this representation, such as application/json.

    • formParameters (pulumi.Input[list]) - One or more form_parameter block as defined above.

      • defaultValue (pulumi.Input[str]) - The default value for this Form Parameter.

      • description (pulumi.Input[str]) - A description of this Form Parameter.

      • name (pulumi.Input[str]) - The Name of this Form Parameter.

      • required (pulumi.Input[bool]) - Is this Form Parameter Required?

      • type (pulumi.Input[str]) - The Type of this Form Parameter, such as a string.

      • values (pulumi.Input[list]) - One or more acceptable values for this Form Parameter.

    • sample (pulumi.Input[str]) - An example of this representation.

    • schema_id (pulumi.Input[str]) - The ID of an API Management Schema which represents this Response.

    • typeName (pulumi.Input[str]) - The Type Name defined by the Schema.

The responses object supports the following:

  • description (pulumi.Input[str]) - A description of the HTTP Response, which may include HTML tags.

  • headers (pulumi.Input[list]) - One or more header blocks as defined above.

    • defaultValue (pulumi.Input[str]) - The default value for this Header.

    • description (pulumi.Input[str]) - A description of this Header.

    • name (pulumi.Input[str]) - The Name of this Header.

    • required (pulumi.Input[bool]) - Is this Header Required?

    • type (pulumi.Input[str]) - The Type of this Header, such as a string.

    • values (pulumi.Input[list]) - One or more acceptable values for this Header.

  • representations (pulumi.Input[list]) - One or more representation blocks as defined below.

    • content_type (pulumi.Input[str]) - The Content Type of this representation, such as application/json.

    • formParameters (pulumi.Input[list]) - One or more form_parameter block as defined above.

      • defaultValue (pulumi.Input[str]) - The default value for this Form Parameter.

      • description (pulumi.Input[str]) - A description of this Form Parameter.

      • name (pulumi.Input[str]) - The Name of this Form Parameter.

      • required (pulumi.Input[bool]) - Is this Form Parameter Required?

      • type (pulumi.Input[str]) - The Type of this Form Parameter, such as a string.

      • values (pulumi.Input[list]) - One or more acceptable values for this Form Parameter.

    • sample (pulumi.Input[str]) - An example of this representation.

    • schema_id (pulumi.Input[str]) - The ID of an API Management Schema which represents this Response.

    • typeName (pulumi.Input[str]) - The Type Name defined by the Schema.

  • statusCode (pulumi.Input[float]) - The HTTP Status Code.

The template_parameters object supports the following:

  • defaultValue (pulumi.Input[str]) - The default value for this Template Parameter.

  • description (pulumi.Input[str]) - A description of this Template Parameter.

  • name (pulumi.Input[str]) - The Name of this Template Parameter.

  • required (pulumi.Input[bool]) - Is this Template Parameter Required?

  • type (pulumi.Input[str]) - The Type of this Template Parameter, such as a string.

  • values (pulumi.Input[list]) - One or more acceptable values for this Template Parameter.

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.ApiOperationPolicy(resource_name, opts=None, api_management_name=None, api_name=None, operation_id=None, resource_group_name=None, xml_content=None, xml_link=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management API Operation Policy

import pulumi
import pulumi_azure as azure

example_api_operation = azure.apimanagement.ApiOperation("exampleApiOperation")
#...
example_api_operation_policy = azure.apimanagement.ApiOperationPolicy("exampleApiOperationPolicy",
    api_name=example_api_operation.api_name,
    api_management_name=example_api_operation.api_management_name,
    resource_group_name=example_api_operation.resource_group_name,
    operation_id=example_api_operation.operation_id,
    xml_content="""<policies>
  <inbound>
    <find-and-replace from="xyz" to="abc" />
  </inbound>
</policies>
""")
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.

  • api_name (pulumi.Input[str]) – The ID of the API Management API Operation 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.

  • xml_content (pulumi.Input[str]) – The XML Content for this Policy.

  • xml_link (pulumi.Input[str]) – A link to a Policy XML Document, which must be publicly available.

api_management_name: pulumi.Output[str] = None

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

api_name: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

xml_content: pulumi.Output[str] = None

The XML Content for this Policy.

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

static get(resource_name, id, opts=None, api_management_name=None, api_name=None, operation_id=None, resource_group_name=None, xml_content=None, xml_link=None)

Get an existing ApiOperationPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

  • api_name (pulumi.Input[str]) – The ID of the API Management API Operation 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.

  • xml_content (pulumi.Input[str]) – The XML Content for this Policy.

  • xml_link (pulumi.Input[str]) – A link to a Policy XML Document, which must be publicly available.

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.ApiPolicy(resource_name, opts=None, api_management_name=None, api_name=None, resource_group_name=None, xml_content=None, xml_link=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management API Policy

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.

  • api_name (pulumi.Input[str]) – The ID of the API Management API 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.

  • xml_content (pulumi.Input[str]) – The XML Content for this Policy as a string.

  • xml_link (pulumi.Input[str]) – A link to a Policy XML Document, which must be publicly available.

api_management_name: pulumi.Output[str] = None

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

api_name: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

xml_content: pulumi.Output[str] = None

The XML Content for this Policy as a string.

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

static get(resource_name, id, opts=None, api_management_name=None, api_name=None, resource_group_name=None, xml_content=None, xml_link=None)

Get an existing ApiPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

  • api_name (pulumi.Input[str]) – The ID of the API Management API 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.

  • xml_content (pulumi.Input[str]) – The XML Content for this Policy as a string.

  • xml_link (pulumi.Input[str]) – A link to a Policy XML Document, which must be publicly available.

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.ApiSchema(resource_name, opts=None, api_management_name=None, api_name=None, content_type=None, resource_group_name=None, schema_id=None, value=None, __props__=None, __name__=None, __opts__=None)

Manages an API Schema within an API Management Service.

import pulumi
import pulumi_azure as azure

example_api = azure.apimanagement.get_api(name="search-api",
    api_management_name="search-api-management",
    resource_group_name="search-service",
    revision="2")
example_api_schema = azure.apimanagement.ApiSchema("exampleApiSchema",
    api_name=example_api.name,
    api_management_name=example_api.api_management_name,
    resource_group_name=example_api.resource_group_name,
    schema_id="example-sche,a",
    content_type="application/vnd.ms-azure-apim.xsd+xml",
    value=(lambda path: open(path).read())("api_management_api_schema.xml"))
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 where the API exists. Changing this forces a new resource to be created.

  • api_name (pulumi.Input[str]) – 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.

  • content_type (pulumi.Input[str]) – The content type of the API Schema.

  • 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.

  • schema_id (pulumi.Input[str]) – A unique identifier for this API Schema. Changing this forces a new resource to be created.

  • value (pulumi.Input[str]) – The JSON escaped string defining the document representing the Schema.

api_management_name: pulumi.Output[str] = None

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

api_name: pulumi.Output[str] = None

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.

content_type: pulumi.Output[str] = None

The content type of the API Schema.

resource_group_name: pulumi.Output[str] = None

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

schema_id: pulumi.Output[str] = None

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

value: pulumi.Output[str] = None

The JSON escaped string defining the document representing the Schema.

static get(resource_name, id, opts=None, api_management_name=None, api_name=None, content_type=None, resource_group_name=None, schema_id=None, value=None)

Get an existing ApiSchema resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.

  • api_name (pulumi.Input[str]) – 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.

  • content_type (pulumi.Input[str]) – The content type of the API Schema.

  • 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.

  • schema_id (pulumi.Input[str]) – A unique identifier for this API Schema. Changing this forces a new resource to be created.

  • value (pulumi.Input[str]) – The JSON escaped string defining the document representing the Schema.

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.ApiVersionSet(resource_name, opts=None, api_management_name=None, description=None, display_name=None, name=None, resource_group_name=None, version_header_name=None, version_query_name=None, versioning_scheme=None, __props__=None, __name__=None, __opts__=None)

Manages an API Version Set within an API Management Service.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Developer_1")
example_api_version_set = azure.apimanagement.ApiVersionSet("exampleApiVersionSet",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    display_name="ExampleAPIVersionSet",
    versioning_scheme="Segment")
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 Version Set should exist. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – The description of API Version Set.

  • display_name (pulumi.Input[str]) – The display name of this API Version Set.

  • name (pulumi.Input[str]) – The name of the API Version Set. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.

  • version_header_name (pulumi.Input[str]) – The name of the Header which should be read from Inbound Requests which defines the API Version.

  • version_query_name (pulumi.Input[str]) – The name of the Query String which should be read from Inbound Requests which defines the API Version.

  • versioning_scheme (pulumi.Input[str]) – Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.

api_management_name: pulumi.Output[str] = None

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

description: pulumi.Output[str] = None

The description of API Version Set.

display_name: pulumi.Output[str] = None

The display name of this API Version Set.

name: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

version_header_name: pulumi.Output[str] = None

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

version_query_name: pulumi.Output[str] = None

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

versioning_scheme: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, description=None, display_name=None, name=None, resource_group_name=None, version_header_name=None, version_query_name=None, versioning_scheme=None)

Get an existing ApiVersionSet resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The name of the API Management Service in which the API Version Set should exist. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – The description of API Version Set.

  • display_name (pulumi.Input[str]) – The display name of this API Version Set.

  • name (pulumi.Input[str]) – The name of the API Version Set. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the parent API Management Service exists. Changing this forces a new resource to be created.

  • version_header_name (pulumi.Input[str]) – The name of the Header which should be read from Inbound Requests which defines the API Version.

  • version_query_name (pulumi.Input[str]) – The name of the Query String which should be read from Inbound Requests which defines the API Version.

  • versioning_scheme (pulumi.Input[str]) – Specifies where in an Inbound HTTP Request that the API Version should be read from. Possible values are Header, Query and Segment.

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.AuthorizationServer(resource_name, opts=None, api_management_name=None, authorization_endpoint=None, authorization_methods=None, bearer_token_sending_methods=None, client_authentication_methods=None, client_id=None, client_registration_endpoint=None, client_secret=None, default_scope=None, description=None, display_name=None, grant_types=None, name=None, resource_group_name=None, resource_owner_password=None, resource_owner_username=None, support_state=None, token_body_parameters=None, token_endpoint=None, __props__=None, __name__=None, __opts__=None)

Manages an Authorization Server within an API Management Service.

import pulumi
import pulumi_azure as azure

example_api = azure.apimanagement.get_api(name="search-api",
    api_management_name="search-api-management",
    resource_group_name="search-service",
    revision="2")
example_authorization_server = azure.apimanagement.AuthorizationServer("exampleAuthorizationServer",
    api_management_name=data["azurerm_api_management"]["example"]["name"],
    resource_group_name=data["azurerm_api_management"]["example"]["resource_group_name"],
    display_name="Test Server",
    authorization_endpoint="https://example.mydomain.com/client/authorize",
    client_id="42424242-4242-4242-4242-424242424242",
    client_registration_endpoint="https://example.mydomain.com/client/register",
    grant_types=["authorizationCode"])
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 this Authorization Server should be created. Changing this forces a new resource to be created.

  • authorization_endpoint (pulumi.Input[str]) – The OAUTH Authorization Endpoint.

  • authorization_methods (pulumi.Input[list]) – The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

  • bearer_token_sending_methods (pulumi.Input[list]) – The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.

  • client_authentication_methods (pulumi.Input[list]) – The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.

  • client_id (pulumi.Input[str]) – The Client/App ID registered with this Authorization Server.

  • client_registration_endpoint (pulumi.Input[str]) – The URI of page where Client/App Registration is performed for this Authorization Server.

  • client_secret (pulumi.Input[str]) – The Client/App Secret registered with this Authorization Server.

  • default_scope (pulumi.Input[str]) – The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.

  • description (pulumi.Input[str]) – A description of the Authorization Server, which may contain HTML formatting tags.

  • display_name (pulumi.Input[str]) – The user-friendly name of this Authorization Server.

  • grant_types (pulumi.Input[list]) – Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.

  • name (pulumi.Input[str]) – The name of this Authorization Server. 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.

  • resource_owner_password (pulumi.Input[str]) – The password associated with the Resource Owner.

  • resource_owner_username (pulumi.Input[str]) – The username associated with the Resource Owner.

  • support_state (pulumi.Input[bool]) – Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.

  • token_endpoint (pulumi.Input[str]) – The OAUTH Token Endpoint.

The token_body_parameters object supports the following:

  • name (pulumi.Input[str]) - The Name of the Parameter.

  • value (pulumi.Input[str]) - The Value of the Parameter.

api_management_name: pulumi.Output[str] = None

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

authorization_endpoint: pulumi.Output[str] = None

The OAUTH Authorization Endpoint.

authorization_methods: pulumi.Output[list] = None

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

bearer_token_sending_methods: pulumi.Output[list] = None

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

client_authentication_methods: pulumi.Output[list] = None

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

client_id: pulumi.Output[str] = None

The Client/App ID registered with this Authorization Server.

client_registration_endpoint: pulumi.Output[str] = None

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

client_secret: pulumi.Output[str] = None

The Client/App Secret registered with this Authorization Server.

default_scope: pulumi.Output[str] = None

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

description: pulumi.Output[str] = None

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

display_name: pulumi.Output[str] = None

The user-friendly name of this Authorization Server.

grant_types: pulumi.Output[list] = None

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

name: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

resource_owner_password: pulumi.Output[str] = None

The password associated with the Resource Owner.

resource_owner_username: pulumi.Output[str] = None

The username associated with the Resource Owner.

support_state: pulumi.Output[bool] = None

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

token_endpoint: pulumi.Output[str] = None

The OAUTH Token Endpoint.

static get(resource_name, id, opts=None, api_management_name=None, authorization_endpoint=None, authorization_methods=None, bearer_token_sending_methods=None, client_authentication_methods=None, client_id=None, client_registration_endpoint=None, client_secret=None, default_scope=None, description=None, display_name=None, grant_types=None, name=None, resource_group_name=None, resource_owner_password=None, resource_owner_username=None, support_state=None, token_body_parameters=None, token_endpoint=None)

Get an existing AuthorizationServer resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.

  • authorization_endpoint (pulumi.Input[str]) – The OAUTH Authorization Endpoint.

  • authorization_methods (pulumi.Input[list]) – The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

  • bearer_token_sending_methods (pulumi.Input[list]) – The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.

  • client_authentication_methods (pulumi.Input[list]) – The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.

  • client_id (pulumi.Input[str]) – The Client/App ID registered with this Authorization Server.

  • client_registration_endpoint (pulumi.Input[str]) – The URI of page where Client/App Registration is performed for this Authorization Server.

  • client_secret (pulumi.Input[str]) – The Client/App Secret registered with this Authorization Server.

  • default_scope (pulumi.Input[str]) – The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.

  • description (pulumi.Input[str]) – A description of the Authorization Server, which may contain HTML formatting tags.

  • display_name (pulumi.Input[str]) – The user-friendly name of this Authorization Server.

  • grant_types (pulumi.Input[list]) – Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.

  • name (pulumi.Input[str]) – The name of this Authorization Server. 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.

  • resource_owner_password (pulumi.Input[str]) – The password associated with the Resource Owner.

  • resource_owner_username (pulumi.Input[str]) – The username associated with the Resource Owner.

  • support_state (pulumi.Input[bool]) – Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.

  • token_endpoint (pulumi.Input[str]) – The OAUTH Token Endpoint.

The token_body_parameters object supports the following:

  • name (pulumi.Input[str]) - The Name of the Parameter.

  • value (pulumi.Input[str]) - The Value of the Parameter.

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.AwaitableGetApiResult(api_management_name=None, description=None, display_name=None, id=None, is_current=None, is_online=None, name=None, path=None, protocols=None, resource_group_name=None, revision=None, service_url=None, soap_pass_through=None, subscription_key_parameter_names=None, version=None, version_set_id=None)
class pulumi_azure.apimanagement.AwaitableGetApiVersionSetResult(api_management_name=None, description=None, display_name=None, id=None, name=None, resource_group_name=None, version_header_name=None, version_query_name=None, versioning_scheme=None)
class pulumi_azure.apimanagement.AwaitableGetGroupResult(api_management_name=None, description=None, display_name=None, external_id=None, id=None, name=None, resource_group_name=None, type=None)
class pulumi_azure.apimanagement.AwaitableGetProductResult(api_management_name=None, approval_required=None, description=None, display_name=None, id=None, product_id=None, published=None, resource_group_name=None, subscription_required=None, subscriptions_limit=None, terms=None)
class pulumi_azure.apimanagement.AwaitableGetServiceResult(additional_locations=None, developer_portal_url=None, gateway_regional_url=None, gateway_url=None, hostname_configurations=None, id=None, identities=None, location=None, management_api_url=None, name=None, notification_sender_email=None, portal_url=None, public_ip_addresses=None, publisher_email=None, publisher_name=None, resource_group_name=None, scm_url=None, sku_name=None, tags=None)
class pulumi_azure.apimanagement.AwaitableGetUserResult(api_management_name=None, email=None, first_name=None, id=None, last_name=None, note=None, resource_group_name=None, state=None, user_id=None)
class pulumi_azure.apimanagement.Backend(resource_name, opts=None, api_management_name=None, credentials=None, description=None, name=None, protocol=None, proxy=None, resource_group_name=None, resource_id=None, service_fabric_cluster=None, title=None, tls=None, url=None, __props__=None, __name__=None, __opts__=None)

Manages a backend within an API Management Service.

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 where this backend should be created. Changing this forces a new resource to be created.

  • credentials (pulumi.Input[dict]) – A credentials block as documented below.

  • description (pulumi.Input[str]) – The description of the backend.

  • name (pulumi.Input[str]) – The name of the API Management backend. Changing this forces a new resource to be created.

  • protocol (pulumi.Input[str]) – The protocol used by the backend host. Possible values are http or soap.

  • proxy (pulumi.Input[dict]) – A proxy block as documented below.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

  • resource_id (pulumi.Input[str]) – The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.

  • service_fabric_cluster (pulumi.Input[dict]) – A service_fabric_cluster block as documented below.

  • title (pulumi.Input[str]) – The title of the backend.

  • tls (pulumi.Input[dict]) – A tls block as documented below.

  • url (pulumi.Input[str]) – The URL of the backend host.

The credentials object supports the following:

  • authorization (pulumi.Input[dict]) - An authorization block as defined below.

    • parameter (pulumi.Input[str]) - The authentication Parameter value.

    • scheme (pulumi.Input[str]) - The authentication Scheme name.

  • certificates (pulumi.Input[list]) - A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.

  • header (pulumi.Input[dict]) - A mapping of header parameters to pass to the backend host. The keys are the header names and the values are a comma separated string of header values. This is converted to a list before being passed to the API.

  • query (pulumi.Input[dict]) - A mapping of query parameters to pass to the backend host. The keys are the query names and the values are a comma separated string of query values. This is converted to a list before being passed to the API.

The proxy object supports the following:

  • password (pulumi.Input[str]) - The password to connect to the proxy server.

  • url (pulumi.Input[str]) - The URL of the proxy server.

  • username (pulumi.Input[str]) - The username to connect to the proxy server.

The service_fabric_cluster object supports the following:

  • clientCertificateThumbprint (pulumi.Input[str]) - The client certificate thumbprint for the management endpoint.

  • managementEndpoints (pulumi.Input[list]) - A list of cluster management endpoints.

  • maxPartitionResolutionRetries (pulumi.Input[float]) - The maximum number of retries when attempting resolve the partition.

  • serverCertificateThumbprints (pulumi.Input[list]) - A list of thumbprints of the server certificates of the Service Fabric cluster.

  • serverX509Names (pulumi.Input[list]) - One or more server_x509_name blocks as documented below.

    • issuerCertificateThumbprint (pulumi.Input[str]) - The thumbprint for the issuer of the certificate.

    • name (pulumi.Input[str]) - The name of the API Management backend. Changing this forces a new resource to be created.

The tls object supports the following:

  • validateCertificateChain (pulumi.Input[bool]) - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for the backend host.

  • validateCertificateName (pulumi.Input[bool]) - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for the backend host.

api_management_name: pulumi.Output[str] = None

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

credentials: pulumi.Output[dict] = None

A credentials block as documented below.

  • authorization (dict) - An authorization block as defined below.

    • parameter (str) - The authentication Parameter value.

    • scheme (str) - The authentication Scheme name.

  • certificates (list) - A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.

  • header (dict) - A mapping of header parameters to pass to the backend host. The keys are the header names and the values are a comma separated string of header values. This is converted to a list before being passed to the API.

  • query (dict) - A mapping of query parameters to pass to the backend host. The keys are the query names and the values are a comma separated string of query values. This is converted to a list before being passed to the API.

description: pulumi.Output[str] = None

The description of the backend.

name: pulumi.Output[str] = None

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

protocol: pulumi.Output[str] = None

The protocol used by the backend host. Possible values are http or soap.

proxy: pulumi.Output[dict] = None

A proxy block as documented below.

  • password (str) - The password to connect to the proxy server.

  • url (str) - The URL of the proxy server.

  • username (str) - The username to connect to the proxy server.

resource_group_name: pulumi.Output[str] = None

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

resource_id: pulumi.Output[str] = None

The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.

service_fabric_cluster: pulumi.Output[dict] = None

A service_fabric_cluster block as documented below.

  • clientCertificateThumbprint (str) - The client certificate thumbprint for the management endpoint.

  • managementEndpoints (list) - A list of cluster management endpoints.

  • maxPartitionResolutionRetries (float) - The maximum number of retries when attempting resolve the partition.

  • serverCertificateThumbprints (list) - A list of thumbprints of the server certificates of the Service Fabric cluster.

  • serverX509Names (list) - One or more server_x509_name blocks as documented below.

    • issuerCertificateThumbprint (str) - The thumbprint for the issuer of the certificate.

    • name (str) - The name of the API Management backend. Changing this forces a new resource to be created.

title: pulumi.Output[str] = None

The title of the backend.

tls: pulumi.Output[dict] = None

A tls block as documented below.

  • validateCertificateChain (bool) - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for the backend host.

  • validateCertificateName (bool) - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for the backend host.

url: pulumi.Output[str] = None

The URL of the backend host.

static get(resource_name, id, opts=None, api_management_name=None, credentials=None, description=None, name=None, protocol=None, proxy=None, resource_group_name=None, resource_id=None, service_fabric_cluster=None, title=None, tls=None, url=None)

Get an existing Backend resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.

  • credentials (pulumi.Input[dict]) – A credentials block as documented below.

  • description (pulumi.Input[str]) – The description of the backend.

  • name (pulumi.Input[str]) – The name of the API Management backend. Changing this forces a new resource to be created.

  • protocol (pulumi.Input[str]) – The protocol used by the backend host. Possible values are http or soap.

  • proxy (pulumi.Input[dict]) – A proxy block as documented below.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

  • resource_id (pulumi.Input[str]) – The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.

  • service_fabric_cluster (pulumi.Input[dict]) – A service_fabric_cluster block as documented below.

  • title (pulumi.Input[str]) – The title of the backend.

  • tls (pulumi.Input[dict]) – A tls block as documented below.

  • url (pulumi.Input[str]) – The URL of the backend host.

The credentials object supports the following:

  • authorization (pulumi.Input[dict]) - An authorization block as defined below.

    • parameter (pulumi.Input[str]) - The authentication Parameter value.

    • scheme (pulumi.Input[str]) - The authentication Scheme name.

  • certificates (pulumi.Input[list]) - A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.

  • header (pulumi.Input[dict]) - A mapping of header parameters to pass to the backend host. The keys are the header names and the values are a comma separated string of header values. This is converted to a list before being passed to the API.

  • query (pulumi.Input[dict]) - A mapping of query parameters to pass to the backend host. The keys are the query names and the values are a comma separated string of query values. This is converted to a list before being passed to the API.

The proxy object supports the following:

  • password (pulumi.Input[str]) - The password to connect to the proxy server.

  • url (pulumi.Input[str]) - The URL of the proxy server.

  • username (pulumi.Input[str]) - The username to connect to the proxy server.

The service_fabric_cluster object supports the following:

  • clientCertificateThumbprint (pulumi.Input[str]) - The client certificate thumbprint for the management endpoint.

  • managementEndpoints (pulumi.Input[list]) - A list of cluster management endpoints.

  • maxPartitionResolutionRetries (pulumi.Input[float]) - The maximum number of retries when attempting resolve the partition.

  • serverCertificateThumbprints (pulumi.Input[list]) - A list of thumbprints of the server certificates of the Service Fabric cluster.

  • serverX509Names (pulumi.Input[list]) - One or more server_x509_name blocks as documented below.

    • issuerCertificateThumbprint (pulumi.Input[str]) - The thumbprint for the issuer of the certificate.

    • name (pulumi.Input[str]) - The name of the API Management backend. Changing this forces a new resource to be created.

The tls object supports the following:

  • validateCertificateChain (pulumi.Input[bool]) - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for the backend host.

  • validateCertificateName (pulumi.Input[bool]) - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for the backend host.

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.Certificate(resource_name, opts=None, api_management_name=None, data=None, name=None, password=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages an Certificate within an API Management Service.

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 where this Service should be created. Changing this forces a new resource to be created.

  • data (pulumi.Input[str]) – The base-64 encoded certificate data, which must be a PFX file. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the API Management Certificate. Changing this forces a new resource to be created.

  • password (pulumi.Input[str]) – The password used for this certificate. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

api_management_name: pulumi.Output[str] = None

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

data: pulumi.Output[str] = None

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

expiration: pulumi.Output[str] = None

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

name: pulumi.Output[str] = None

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

password: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

subject: pulumi.Output[str] = None

The Subject of this Certificate.

thumbprint: pulumi.Output[str] = None

The Thumbprint of this Certificate.

static get(resource_name, id, opts=None, api_management_name=None, data=None, expiration=None, name=None, password=None, resource_group_name=None, subject=None, thumbprint=None)

Get an existing Certificate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this Service should be created. Changing this forces a new resource to be created.

  • data (pulumi.Input[str]) – The base-64 encoded certificate data, which must be a PFX file. Changing this forces a new resource to be created.

  • expiration (pulumi.Input[str]) – The Expiration Date of this Certificate, formatted as an RFC3339 string.

  • name (pulumi.Input[str]) – The name of the API Management Certificate. Changing this forces a new resource to be created.

  • password (pulumi.Input[str]) – The password used for this certificate. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

  • subject (pulumi.Input[str]) – The Subject of this Certificate.

  • thumbprint (pulumi.Input[str]) – The Thumbprint of this Certificate.

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.Diagnostic(resource_name, opts=None, api_management_logger_id=None, api_management_name=None, enabled=None, identifier=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management Service Diagnostic.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_insights = azure.appinsights.Insights("exampleInsights",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    application_type="web")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@mycompany.io",
    sku_name="Developer_1")
example_logger = azure.apimanagement.Logger("exampleLogger",
    api_management_name=example_service.name,
    resource_group_name=example_resource_group.name,
    application_insights={
        "instrumentation_key": example_insights.instrumentation_key,
    })
example_diagnostic = azure.apimanagement.Diagnostic("exampleDiagnostic",
    identifier="applicationinsights",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    api_management_logger_id=example_logger.id)
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_logger_id (pulumi.Input[str]) – The id of the target API Management Logger where the API Management Diagnostic should be saved.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this Diagnostic should be created. Changing this forces a new resource to be created.

  • identifier (pulumi.Input[str]) – The diagnostic identifier for the API Management Service. At this time the only supported value is applicationinsights. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

api_management_logger_id: pulumi.Output[str] = None

The id of the target API Management Logger where the API Management Diagnostic should be saved.

api_management_name: pulumi.Output[str] = None

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

identifier: pulumi.Output[str] = None

The diagnostic identifier for the API Management Service. At this time the only supported value is applicationinsights. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_logger_id=None, api_management_name=None, enabled=None, identifier=None, resource_group_name=None)

Get an existing Diagnostic resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_logger_id (pulumi.Input[str]) – The id of the target API Management Logger where the API Management Diagnostic should be saved.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this Diagnostic should be created. Changing this forces a new resource to be created.

  • identifier (pulumi.Input[str]) – The diagnostic identifier for the API Management Service. At this time the only supported value is applicationinsights. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where 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.GetApiResult(api_management_name=None, description=None, display_name=None, id=None, is_current=None, is_online=None, name=None, path=None, protocols=None, resource_group_name=None, revision=None, service_url=None, soap_pass_through=None, subscription_key_parameter_names=None, version=None, version_set_id=None)

A collection of values returned by getApi.

description = None

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

display_name = None

The display name of the API.

id = None

The provider-assigned unique ID for this managed resource.

is_current = None

Is this the current API Revision?

is_online = None

Is this API Revision online/accessible via the Gateway?

path = None

The Path for this API Management API.

protocols = None

A list of protocols the operations in this API can be invoked.

service_url = None

Absolute URL of the backend service implementing this API.

soap_pass_through = None

Should this API expose a SOAP frontend, rather than a HTTP frontend?

subscription_key_parameter_names = None

A subscription_key_parameter_names block as documented below.

version = None

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

version_set_id = None

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

class pulumi_azure.apimanagement.GetApiVersionSetResult(api_management_name=None, description=None, display_name=None, id=None, name=None, resource_group_name=None, version_header_name=None, version_query_name=None, versioning_scheme=None)

A collection of values returned by getApiVersionSet.

description = None

The description of API Version Set.

display_name = None

The display name of this API Version Set.

id = None

The provider-assigned unique ID for this managed resource.

version_header_name = None

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

version_query_name = None

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

class pulumi_azure.apimanagement.GetGroupResult(api_management_name=None, description=None, display_name=None, external_id=None, id=None, name=None, resource_group_name=None, type=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.

id = None

The provider-assigned unique ID for this managed resource.

type = None

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

class pulumi_azure.apimanagement.GetProductResult(api_management_name=None, approval_required=None, description=None, display_name=None, id=None, product_id=None, published=None, resource_group_name=None, subscription_required=None, subscriptions_limit=None, terms=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.

id = None

The provider-assigned unique ID for this managed resource.

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.

class pulumi_azure.apimanagement.GetServiceResult(additional_locations=None, developer_portal_url=None, gateway_regional_url=None, gateway_url=None, hostname_configurations=None, id=None, identities=None, location=None, management_api_url=None, name=None, notification_sender_email=None, portal_url=None, public_ip_addresses=None, publisher_email=None, publisher_name=None, resource_group_name=None, scm_url=None, sku_name=None, tags=None)

A collection of values returned by getService.

additional_locations = None

One or more additional_location blocks as defined below

developer_portal_url = None

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

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.

id = None

The provider-assigned unique ID for this managed resource.

identities = None

(Optional) An identity 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.

name = None

Specifies the plan’s pricing tier.

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.

tags = None

A mapping of tags assigned to the resource.

class pulumi_azure.apimanagement.GetUserResult(api_management_name=None, email=None, first_name=None, id=None, last_name=None, note=None, resource_group_name=None, state=None, user_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.

id = None

The provider-assigned unique ID for this managed resource.

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.

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, __props__=None, __name__=None, __opts__=None)

Manages an API Management Group.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Developer_1")
example_group = azure.apimanagement.Group("exampleGroup",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    display_name="Example Group",
    description="This is an example 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: pulumi.Output[str] = 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: pulumi.Output[str] = None

The description of this API Management Group.

display_name: pulumi.Output[str] = None

The display name of this API Management Group.

external_id: pulumi.Output[str] = None

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

name: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, description=None, display_name=None, external_id=None, name=None, resource_group_name=None, type=None)

Get an existing Group resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

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, __props__=None, __name__=None, __opts__=None)

Manages an API Management User Assignment to a Group.

import pulumi
import pulumi_azure as azure

example_user = azure.apimanagement.get_user(user_id="my-user",
    api_management_name="example-apim",
    resource_group_name="search-service")
example_group_user = azure.apimanagement.GroupUser("exampleGroupUser",
    user_id=example_user.id,
    group_name="example-group",
    resource_group_name=example_user.resource_group_name,
    api_management_name=example_user.api_management_name)
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: pulumi.Output[str] = None

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

group_name: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = 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.

static get(resource_name, id, opts=None, api_management_name=None, group_name=None, resource_group_name=None, user_id=None)

Get an existing GroupUser resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

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.IdentityProviderAad(resource_name, opts=None, allowed_tenants=None, api_management_name=None, client_id=None, client_secret=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management AAD Identity Provider.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@mycompany.io",
    sku_name="Developer_1")
example_identity_provider_aad = azure.apimanagement.IdentityProviderAad("exampleIdentityProviderAad",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    client_id="00000000-0000-0000-0000-000000000000",
    client_secret="00000000000000000000000000000000",
    allowed_tenants=["00000000-0000-0000-0000-000000000000"])
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • allowed_tenants (pulumi.Input[list]) – List of allowed AAD Tenants.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.

  • client_id (pulumi.Input[str]) – Client Id of the Application in the AAD Identity Provider.

  • client_secret (pulumi.Input[str]) – Client secret of the Application in the AAD Identity Provider.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

allowed_tenants: pulumi.Output[list] = None

List of allowed AAD Tenants.

api_management_name: pulumi.Output[str] = None

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

client_id: pulumi.Output[str] = None

Client Id of the Application in the AAD Identity Provider.

client_secret: pulumi.Output[str] = None

Client secret of the Application in the AAD Identity Provider.

resource_group_name: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, allowed_tenants=None, api_management_name=None, client_id=None, client_secret=None, resource_group_name=None)

Get an existing IdentityProviderAad resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • allowed_tenants (pulumi.Input[list]) – List of allowed AAD Tenants.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.

  • client_id (pulumi.Input[str]) – Client Id of the Application in the AAD Identity Provider.

  • client_secret (pulumi.Input[str]) – Client secret of the Application in the AAD Identity Provider.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where 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.IdentityProviderFacebook(resource_name, opts=None, api_management_name=None, app_id=None, app_secret=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management Facebook Identity Provider.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@mycompany.io",
    sku_name="Developer_1")
example_identity_provider_facebook = azure.apimanagement.IdentityProviderFacebook("exampleIdentityProviderFacebook",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    app_id="00000000000000000000000000000000",
    app_secret="00000000000000000000000000000000")
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 where this Facebook Identity Provider should be created. Changing this forces a new resource to be created.

  • app_id (pulumi.Input[str]) – App ID for Facebook.

  • app_secret (pulumi.Input[str]) – App Secret for Facebook.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

api_management_name: pulumi.Output[str] = None

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

app_id: pulumi.Output[str] = None

App ID for Facebook.

app_secret: pulumi.Output[str] = None

App Secret for Facebook.

resource_group_name: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, app_id=None, app_secret=None, resource_group_name=None)

Get an existing IdentityProviderFacebook resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this Facebook Identity Provider should be created. Changing this forces a new resource to be created.

  • app_id (pulumi.Input[str]) – App ID for Facebook.

  • app_secret (pulumi.Input[str]) – App Secret for Facebook.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where 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.IdentityProviderGoogle(resource_name, opts=None, api_management_name=None, client_id=None, client_secret=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management Google Identity Provider.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@mycompany.io",
    sku_name="Developer_1")
example_identity_provider_google = azure.apimanagement.IdentityProviderGoogle("exampleIdentityProviderGoogle",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    client_id="00000000.apps.googleusercontent.com",
    client_secret="00000000000000000000000000000000")
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 where this Google Identity Provider should be created. Changing this forces a new resource to be created.

  • client_id (pulumi.Input[str]) – Client Id for Google Sign-in.

  • client_secret (pulumi.Input[str]) – Client secret for Google Sign-in.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

api_management_name: pulumi.Output[str] = None

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

client_id: pulumi.Output[str] = None

Client Id for Google Sign-in.

client_secret: pulumi.Output[str] = None

Client secret for Google Sign-in.

resource_group_name: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, client_id=None, client_secret=None, resource_group_name=None)

Get an existing IdentityProviderGoogle resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this Google Identity Provider should be created. Changing this forces a new resource to be created.

  • client_id (pulumi.Input[str]) – Client Id for Google Sign-in.

  • client_secret (pulumi.Input[str]) – Client secret for Google Sign-in.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where 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.IdentityProviderMicrosoft(resource_name, opts=None, api_management_name=None, client_id=None, client_secret=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management Microsoft Identity Provider.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@mycompany.io",
    sku_name="Developer_1")
example_identity_provider_microsoft = azure.apimanagement.IdentityProviderMicrosoft("exampleIdentityProviderMicrosoft",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    client_id="00000000-0000-0000-0000-000000000000",
    client_secret="00000000000000000000000000000000")
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 where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.

  • client_id (pulumi.Input[str]) – Client Id of the Azure AD Application.

  • client_secret (pulumi.Input[str]) – Client secret of the Azure AD Application.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

api_management_name: pulumi.Output[str] = None

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

client_id: pulumi.Output[str] = None

Client Id of the Azure AD Application.

client_secret: pulumi.Output[str] = None

Client secret of the Azure AD Application.

resource_group_name: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, client_id=None, client_secret=None, resource_group_name=None)

Get an existing IdentityProviderMicrosoft resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this Microsoft Identity Provider should be created. Changing this forces a new resource to be created.

  • client_id (pulumi.Input[str]) – Client Id of the Azure AD Application.

  • client_secret (pulumi.Input[str]) – Client secret of the Azure AD Application.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where 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.IdentityProviderTwitter(resource_name, opts=None, api_key=None, api_management_name=None, api_secret_key=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management Twitter Identity Provider.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@mycompany.io",
    sku_name="Developer_1")
example_identity_provider_twitter = azure.apimanagement.IdentityProviderTwitter("exampleIdentityProviderTwitter",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    api_key="00000000000000000000000000000000",
    api_secret_key="00000000000000000000000000000000")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_key (pulumi.Input[str]) – App Consumer API key for Twitter.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this Twitter Identity Provider should be created. Changing this forces a new resource to be created.

  • api_secret_key (pulumi.Input[str]) – App Consumer API secret key for Twitter.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

api_key: pulumi.Output[str] = None

App Consumer API key for Twitter.

api_management_name: pulumi.Output[str] = None

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

api_secret_key: pulumi.Output[str] = None

App Consumer API secret key for Twitter.

resource_group_name: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_key=None, api_management_name=None, api_secret_key=None, resource_group_name=None)

Get an existing IdentityProviderTwitter resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_key (pulumi.Input[str]) – App Consumer API key for Twitter.

  • api_management_name (pulumi.Input[str]) – The Name of the API Management Service where this Twitter Identity Provider should be created. Changing this forces a new resource to be created.

  • api_secret_key (pulumi.Input[str]) – App Consumer API secret key for Twitter.

  • resource_group_name (pulumi.Input[str]) – The Name of the Resource Group where 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.Logger(resource_name, opts=None, api_management_name=None, application_insights=None, buffered=None, description=None, eventhub=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages a Logger within an API Management Service.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_insights = azure.appinsights.Insights("exampleInsights",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    application_type="other")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
example_logger = azure.apimanagement.Logger("exampleLogger",
    api_management_name=example_service.name,
    resource_group_name=example_resource_group.name,
    application_insights={
        "instrumentation_key": example_insights.instrumentation_key,
    })
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.

  • application_insights (pulumi.Input[dict]) – An application_insights block as documented below.

  • buffered (pulumi.Input[bool]) – Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.

  • description (pulumi.Input[str]) – A description of this Logger.

  • eventhub (pulumi.Input[dict]) – An eventhub block as documented below.

  • name (pulumi.Input[str]) – The name of this Logger, which must be unique 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.

The application_insights object supports the following:

  • instrumentation_key (pulumi.Input[str]) - The instrumentation key used to push data to Application Insights.

The eventhub object supports the following:

  • connection_string (pulumi.Input[str]) - The connection string of an EventHub Namespace.

  • name (pulumi.Input[str]) - The name of an EventHub.

api_management_name: pulumi.Output[str] = None

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

application_insights: pulumi.Output[dict] = None

An application_insights block as documented below.

  • instrumentation_key (str) - The instrumentation key used to push data to Application Insights.

buffered: pulumi.Output[bool] = None

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

description: pulumi.Output[str] = None

A description of this Logger.

eventhub: pulumi.Output[dict] = None

An eventhub block as documented below.

  • connection_string (str) - The connection string of an EventHub Namespace.

  • name (str) - The name of an EventHub.

name: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, application_insights=None, buffered=None, description=None, eventhub=None, name=None, resource_group_name=None)

Get an existing Logger resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

  • application_insights (pulumi.Input[dict]) – An application_insights block as documented below.

  • buffered (pulumi.Input[bool]) – Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.

  • description (pulumi.Input[str]) – A description of this Logger.

  • eventhub (pulumi.Input[dict]) – An eventhub block as documented below.

  • name (pulumi.Input[str]) – The name of this Logger, which must be unique 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.

The application_insights object supports the following:

  • instrumentation_key (pulumi.Input[str]) - The instrumentation key used to push data to Application Insights.

The eventhub object supports the following:

  • connection_string (pulumi.Input[str]) - The connection string of an EventHub Namespace.

  • name (pulumi.Input[str]) - The name of an EventHub.

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.NamedValue(resource_name, opts=None, api_management_name=None, display_name=None, name=None, resource_group_name=None, secret=None, tags=None, value=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management Named Value.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Developer_1")
example_named_value = azure.apimanagement.NamedValue("exampleNamedValue",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    display_name="ExampleProperty",
    value="Example Value")
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 Named Value should exist. Changing this forces a new resource to be created.

  • display_name (pulumi.Input[str]) – The display name of this API Management Named Value.

  • name (pulumi.Input[str]) – The name of the API Management Named Value. 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 Named Value should exist. Changing this forces a new resource to be created.

  • secret (pulumi.Input[bool]) – Specifies whether the API Management Named Value 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 Named Value.

  • value (pulumi.Input[str]) – The value of this API Management Named Value.

api_management_name: pulumi.Output[str] = None

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

display_name: pulumi.Output[str] = None

The display name of this API Management Named Value.

name: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

secret: pulumi.Output[bool] = None

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

tags: pulumi.Output[list] = None

A list of tags to be applied to the API Management Named Value.

value: pulumi.Output[str] = None

The value of this API Management Named Value.

static get(resource_name, id, opts=None, api_management_name=None, display_name=None, name=None, resource_group_name=None, secret=None, tags=None, value=None)

Get an existing NamedValue resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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 Named Value should exist. Changing this forces a new resource to be created.

  • display_name (pulumi.Input[str]) – The display name of this API Management Named Value.

  • name (pulumi.Input[str]) – The name of the API Management Named Value. 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 Named Value should exist. Changing this forces a new resource to be created.

  • secret (pulumi.Input[bool]) – Specifies whether the API Management Named Value 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 Named Value.

  • value (pulumi.Input[str]) – The value of this API Management Named Value.

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.OpenIdConnectProvider(resource_name, opts=None, api_management_name=None, client_id=None, client_secret=None, description=None, display_name=None, metadata_endpoint=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages an OpenID Connect Provider within a API Management Service.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
example_open_id_connect_provider = azure.apimanagement.OpenIdConnectProvider("exampleOpenIdConnectProvider",
    api_management_name=example_service.name,
    resource_group_name=example_resource_group.name,
    client_id="00001111-2222-3333-4444-555566667777",
    display_name="Example Provider",
    metadata_endpoint="https://example.com/example")
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 this OpenID Connect Provider should be created. Changing this forces a new resource to be created.

  • client_id (pulumi.Input[str]) – The Client ID used for the Client Application.

  • client_secret (pulumi.Input[str]) – The Client Secret used for the Client Application.

  • description (pulumi.Input[str]) – A description of this OpenID Connect Provider.

  • display_name (pulumi.Input[str]) – A user-friendly name for this OpenID Connect Provider.

  • metadata_endpoint (pulumi.Input[str]) – The URI of the Metadata endpoint.

  • name (pulumi.Input[str]) – 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.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

api_management_name: pulumi.Output[str] = None

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.

client_id: pulumi.Output[str] = None

The Client ID used for the Client Application.

client_secret: pulumi.Output[str] = None

The Client Secret used for the Client Application.

description: pulumi.Output[str] = None

A description of this OpenID Connect Provider.

display_name: pulumi.Output[str] = None

A user-friendly name for this OpenID Connect Provider.

metadata_endpoint: pulumi.Output[str] = None

The URI of the Metadata endpoint.

name: pulumi.Output[str] = None

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.

resource_group_name: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, client_id=None, client_secret=None, description=None, display_name=None, metadata_endpoint=None, name=None, resource_group_name=None)

Get an existing OpenIdConnectProvider resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – 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.

  • client_id (pulumi.Input[str]) – The Client ID used for the Client Application.

  • client_secret (pulumi.Input[str]) – The Client Secret used for the Client Application.

  • description (pulumi.Input[str]) – A description of this OpenID Connect Provider.

  • display_name (pulumi.Input[str]) – A user-friendly name for this OpenID Connect Provider.

  • metadata_endpoint (pulumi.Input[str]) – The URI of the Metadata endpoint.

  • name (pulumi.Input[str]) – 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.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group where 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.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, __props__=None, __name__=None, __opts__=None)

Manages an API Management Product.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
example_product = azure.apimanagement.Product("exampleProduct",
    product_id="test-product",
    api_management_name=example_service.name,
    resource_group_name=example_resource_group.name,
    display_name="Test Product",
    subscription_required=True,
    approval_required=True,
    published=True)
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: pulumi.Output[str] = None

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

approval_required: pulumi.Output[bool] = None

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

description: pulumi.Output[str] = None

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

display_name: pulumi.Output[str] = None

The Display Name for this API Management Product.

product_id: pulumi.Output[str] = 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: pulumi.Output[bool] = None

Is this Product Published?

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[bool] = None

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

subscriptions_limit: pulumi.Output[float] = None

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

terms: pulumi.Output[str] = None

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

static get(resource_name, id, 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)

Get an existing Product resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

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.ProductApi(resource_name, opts=None, api_management_name=None, api_name=None, product_id=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management API Assignment to a Product.

import pulumi
import pulumi_azure as azure

example_service = azure.apimanagement.get_service(name="example-api",
    resource_group_name="example-resources")
example_api = azure.apimanagement.get_api(name="search-api",
    api_management_name=example_service.name,
    resource_group_name=example_service.resource_group_name,
    revision="2")
example_product = azure.apimanagement.get_product(product_id="my-product",
    api_management_name=example_service.name,
    resource_group_name=example_service.resource_group_name)
example_product_api = azure.apimanagement.ProductApi("exampleProductApi",
    api_name=example_api.name,
    product_id=example_product.product_id,
    api_management_name=example_service.name,
    resource_group_name=example_service.resource_group_name)
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.

  • api_name (pulumi.Input[str]) – The Name of the API Management API within the API Management Service. Changing this forces a new resource to be created.

  • product_id (pulumi.Input[str]) – The ID of the API Management Product 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: pulumi.Output[str] = None

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

api_name: pulumi.Output[str] = None

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

product_id: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, api_name=None, product_id=None, resource_group_name=None)

Get an existing ProductApi resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

  • api_name (pulumi.Input[str]) – The Name of the API Management API within the API Management Service. Changing this forces a new resource to be created.

  • product_id (pulumi.Input[str]) – The ID of the API Management Product 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.

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, __props__=None, __name__=None, __opts__=None)

Manages an API Management Product Assignment to a Group.

import pulumi
import pulumi_azure as azure

example_service = azure.apimanagement.get_service(name="example-api",
    resource_group_name="example-resources")
example_product = azure.apimanagement.get_product(product_id="my-product",
    api_management_name=example_service.name,
    resource_group_name=example_service.resource_group_name)
example_group = azure.apimanagement.get_group(name="my-group",
    api_management_name=example_service.name,
    resource_group_name=example_service.resource_group_name)
example_product_group = azure.apimanagement.ProductGroup("exampleProductGroup",
    product_id=example_product.product_id,
    group_name=example_group.name,
    api_management_name=example_service.name,
    resource_group_name=example_service.resource_group_name)
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.

  • product_id (pulumi.Input[str]) – The ID of the API Management Product 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: pulumi.Output[str] = None

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

group_name: pulumi.Output[str] = None

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

product_id: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, group_name=None, product_id=None, resource_group_name=None)

Get an existing ProductGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

  • product_id (pulumi.Input[str]) – The ID of the API Management Product 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.

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.ProductPolicy(resource_name, opts=None, api_management_name=None, product_id=None, resource_group_name=None, xml_content=None, xml_link=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management Product Policy

import pulumi
import pulumi_azure as azure

example_product = azure.apimanagement.get_product(product_id="my-product",
    api_management_name="example-apim",
    resource_group_name="search-service")
example_product_policy = azure.apimanagement.ProductPolicy("exampleProductPolicy",
    product_id=example_product.product_id,
    api_management_name=example_product.api_management_name,
    resource_group_name=example_product.resource_group_name,
    xml_content="""<policies>
  <inbound>
    <find-and-replace from="xyz" to="abc" />
  </inbound>
</policies>
""")
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.

  • product_id (pulumi.Input[str]) – The ID of the API Management Product 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.

  • xml_content (pulumi.Input[str]) – The XML Content for this Policy.

  • xml_link (pulumi.Input[str]) – A link to a Policy XML Document, which must be publicly available.

api_management_name: pulumi.Output[str] = None

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

product_id: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

xml_content: pulumi.Output[str] = None

The XML Content for this Policy.

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

static get(resource_name, id, opts=None, api_management_name=None, product_id=None, resource_group_name=None, xml_content=None, xml_link=None)

Get an existing ProductPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

  • product_id (pulumi.Input[str]) – The ID of the API Management Product 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.

  • xml_content (pulumi.Input[str]) – The XML Content for this Policy.

  • xml_link (pulumi.Input[str]) – A link to a Policy XML Document, which must be publicly available.

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, __props__=None, __name__=None, __opts__=None)

Manages an API Management Property.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Developer_1")
example_property = azure.apimanagement.Property("exampleProperty",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    display_name="ExampleProperty",
    value="Example Value")
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: pulumi.Output[str] = 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: pulumi.Output[str] = None

The display name of this API Management Property.

name: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[bool] = None

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

tags: pulumi.Output[list] = None

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

value: pulumi.Output[str] = None

The value of this API Management Property.

static get(resource_name, id, opts=None, api_management_name=None, display_name=None, name=None, resource_group_name=None, secret=None, tags=None, value=None)

Get an existing Property resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

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.Service(resource_name, opts=None, additional_locations=None, certificates=None, hostname_configuration=None, identity=None, location=None, name=None, notification_sender_email=None, policy=None, protocols=None, publisher_email=None, publisher_name=None, resource_group_name=None, security=None, sign_in=None, sign_up=None, sku_name=None, tags=None, virtual_network_configuration=None, virtual_network_type=None, __props__=None, __name__=None, __opts__=None)

Manages an API Management Service.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1",
    policy={
        "xml_content": """    <policies>
      <inbound />
      <backend />
      <outbound />
      <on-error />
    </policies>
""",
    })
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • additional_locations (pulumi.Input[list]) – 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.

  • policy (pulumi.Input[dict]) – A policy block as defined below.

  • protocols (pulumi.Input[dict]) – A protocols block as defined below.

  • 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.

  • sign_in (pulumi.Input[dict]) – A sign_in block as defined below.

  • sign_up (pulumi.Input[dict]) – A sign_up block as defined below.

  • sku_name (pulumi.Input[str]) – sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

  • tags (pulumi.Input[dict]) – A mapping of tags assigned to the resource.

  • virtual_network_configuration (pulumi.Input[dict]) – A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

  • virtual_network_type (pulumi.Input[str]) – The type of virtual network you want to use, valid values include: None, External, Internal.

The additional_locations object supports the following:

  • gateway_regional_url (pulumi.Input[str]) - The URL of the Regional Gateway for the API Management Service in the specified region.

  • location (pulumi.Input[str]) - The name of the Azure Region in which the API Management Service should be expanded to.

  • public_ip_addresses (pulumi.Input[list]) - Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.

The certificates object supports the following:

  • certificatePassword (pulumi.Input[str]) - The password for the certificate.

  • encodedCertificate (pulumi.Input[str]) - The Base64 Encoded PFX Certificate.

  • storeName (pulumi.Input[str]) - The name of the Certificate Store where this certificate should be stored. Possible values are CertificateAuthority and Root.

The hostname_configuration object supports the following:

  • developerPortals (pulumi.Input[list]) - One or more developer_portal blocks as documented below.

    • certificate (pulumi.Input[str]) - One or more (up to 10) certificate blocks as defined below.

    • certificatePassword (pulumi.Input[str]) - The password for the certificate.

    • host_name (pulumi.Input[str]) - The Hostname to use for the Management API.

    • key_vault_id (pulumi.Input[str]) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (pulumi.Input[bool]) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • managements (pulumi.Input[list]) - One or more management blocks as documented below.

    • certificate (pulumi.Input[str]) - The Base64 Encoded Certificate.

    • certificatePassword (pulumi.Input[str]) - The password associated with the certificate provided above.

    • host_name (pulumi.Input[str]) - The Hostname to use for the Management API.

    • key_vault_id (pulumi.Input[str]) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (pulumi.Input[bool]) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • portals (pulumi.Input[list]) - One or more portal blocks as documented below.

    • certificate (pulumi.Input[str]) - One or more (up to 10) certificate blocks as defined below.

    • certificatePassword (pulumi.Input[str]) - The password for the certificate.

    • host_name (pulumi.Input[str]) - The Hostname to use for the Management API.

    • key_vault_id (pulumi.Input[str]) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (pulumi.Input[bool]) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • proxies (pulumi.Input[list]) - One or more proxy blocks as documented below.

    • certificate (pulumi.Input[str]) - The Base64 Encoded Certificate.

    • certificatePassword (pulumi.Input[str]) - The password associated with the certificate provided above.

    • defaultSslBinding (pulumi.Input[bool]) - Is the certificate associated with this Hostname the Default SSL Certificate? This is used when an SNI header isn’t specified by a client. Defaults to false.

    • host_name (pulumi.Input[str]) - The Hostname to use for the Management API.

    • key_vault_id (pulumi.Input[str]) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (pulumi.Input[bool]) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • scms (pulumi.Input[list]) - One or more scm blocks as documented below.

    • certificate (pulumi.Input[str]) - One or more (up to 10) certificate blocks as defined below.

    • certificatePassword (pulumi.Input[str]) - The password for the certificate.

    • host_name (pulumi.Input[str]) - The Hostname to use for the Management API.

    • key_vault_id (pulumi.Input[str]) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (pulumi.Input[bool]) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

The identity object supports the following:

  • identityIds (pulumi.Input[list]) - A list of IDs for User Assigned Managed Identity resources to be assigned.

  • principal_id (pulumi.Input[str]) - The Principal ID associated with this Managed Service Identity.

  • tenant_id (pulumi.Input[str]) - The Tenant ID associated with this Managed Service Identity.

  • type (pulumi.Input[str]) - Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned (to enable both).

The policy object supports the following:

  • xml_content (pulumi.Input[str]) - The XML Content for this Policy.

  • xml_link (pulumi.Input[str]) - A link to an API Management Policy XML Document, which must be publicly available.

The protocols object supports the following:

  • enable_http2 (pulumi.Input[bool]) - Should HTTP/2 be supported by the API Management Service? Defaults to false.

The security object supports the following:

  • enableBackendSsl30 (pulumi.Input[bool]) - Should SSL 3.0 be enabled on the backend of the gateway? Defaults to false.

  • enableBackendTls10 (pulumi.Input[bool]) - Should TLS 1.0 be enabled on the backend of the gateway? Defaults to false.

  • enableBackendTls11 (pulumi.Input[bool]) - Should TLS 1.1 be enabled on the backend of the gateway? Defaults to false.

  • enableFrontendSsl30 (pulumi.Input[bool]) - Should SSL 3.0 be enabled on the frontend of the gateway? Defaults to false.

  • enableFrontendTls10 (pulumi.Input[bool]) - Should TLS 1.0 be enabled on the frontend of the gateway? Defaults to false.

  • enableFrontendTls11 (pulumi.Input[bool]) - Should TLS 1.1 be enabled on the frontend of the gateway? Defaults to false.

  • enableTripleDesCiphers (pulumi.Input[bool]) - Should the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)? Defaults to false.

The sign_in object supports the following:

  • enabled (pulumi.Input[bool]) - Should anonymous users be redirected to the sign in page?

The sign_up object supports the following:

  • enabled (pulumi.Input[bool]) - Can users sign up on the development portal?

  • termsOfService (pulumi.Input[dict]) - A terms_of_service block as defined below.

    • consentRequired (pulumi.Input[bool]) - Should the user be asked for consent during sign up?

    • enabled (pulumi.Input[bool]) - Should Terms of Service be displayed during sign up?.

    • text (pulumi.Input[str]) - The Terms of Service which users are required to agree to in order to sign up.

The virtual_network_configuration object supports the following:

  • subnet_id (pulumi.Input[str]) - The id of the subnet that will be used for the API Management.

additional_locations: pulumi.Output[list] = None

One or more additional_location blocks as defined below.

  • gateway_regional_url (str) - The URL of the Regional Gateway for the API Management Service in the specified region.

  • location (str) - The name of the Azure Region in which the API Management Service should be expanded to.

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

certificates: pulumi.Output[list] = None

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

  • certificatePassword (str) - The password for the certificate.

  • encodedCertificate (str) - The Base64 Encoded PFX Certificate.

  • storeName (str) - The name of the Certificate Store where this certificate should be stored. Possible values are CertificateAuthority and Root.

developer_portal_url: pulumi.Output[str] = None

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

gateway_regional_url: pulumi.Output[str] = None

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

gateway_url: pulumi.Output[str] = None

The URL of the Gateway for the API Management Service.

hostname_configuration: pulumi.Output[dict] = None

A hostname_configuration block as defined below.

  • developerPortals (list) - One or more developer_portal blocks as documented below.

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

    • certificatePassword (str) - The password for the certificate.

    • host_name (str) - The Hostname to use for the Management API.

    • key_vault_id (str) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (bool) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • managements (list) - One or more management blocks as documented below.

    • certificate (str) - The Base64 Encoded Certificate.

    • certificatePassword (str) - The password associated with the certificate provided above.

    • host_name (str) - The Hostname to use for the Management API.

    • key_vault_id (str) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (bool) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • portals (list) - One or more portal blocks as documented below.

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

    • certificatePassword (str) - The password for the certificate.

    • host_name (str) - The Hostname to use for the Management API.

    • key_vault_id (str) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (bool) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • proxies (list) - One or more proxy blocks as documented below.

    • certificate (str) - The Base64 Encoded Certificate.

    • certificatePassword (str) - The password associated with the certificate provided above.

    • defaultSslBinding (bool) - Is the certificate associated with this Hostname the Default SSL Certificate? This is used when an SNI header isn’t specified by a client. Defaults to false.

    • host_name (str) - The Hostname to use for the Management API.

    • key_vault_id (str) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (bool) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • scms (list) - One or more scm blocks as documented below.

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

    • certificatePassword (str) - The password for the certificate.

    • host_name (str) - The Hostname to use for the Management API.

    • key_vault_id (str) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (bool) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

identity: pulumi.Output[dict] = None

An identity block is documented below.

  • identityIds (list) - A list of IDs for User Assigned Managed Identity resources to be assigned.

  • principal_id (str) - The Principal ID associated with this Managed Service Identity.

  • tenant_id (str) - The Tenant ID associated with this Managed Service Identity.

  • type (str) - Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned (to enable both).

location: pulumi.Output[str] = None

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

management_api_url: pulumi.Output[str] = None

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

name: pulumi.Output[str] = None

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

notification_sender_email: pulumi.Output[str] = None

Email address from which the notification will be sent.

policy: pulumi.Output[dict] = None

A policy block as defined below.

  • xml_content (str) - The XML Content for this Policy.

  • xml_link (str) - A link to an API Management Policy XML Document, which must be publicly available.

portal_url: pulumi.Output[str] = None

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

protocols: pulumi.Output[dict] = None

A protocols block as defined below.

  • enable_http2 (bool) - Should HTTP/2 be supported by the API Management Service? Defaults to false.

public_ip_addresses: pulumi.Output[list] = 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: pulumi.Output[str] = None

The email of publisher/company.

publisher_name: pulumi.Output[str] = None

The name of publisher/company.

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None

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

security: pulumi.Output[dict] = None

A security block as defined below.

  • enableBackendSsl30 (bool) - Should SSL 3.0 be enabled on the backend of the gateway? Defaults to false.

  • enableBackendTls10 (bool) - Should TLS 1.0 be enabled on the backend of the gateway? Defaults to false.

  • enableBackendTls11 (bool) - Should TLS 1.1 be enabled on the backend of the gateway? Defaults to false.

  • enableFrontendSsl30 (bool) - Should SSL 3.0 be enabled on the frontend of the gateway? Defaults to false.

  • enableFrontendTls10 (bool) - Should TLS 1.0 be enabled on the frontend of the gateway? Defaults to false.

  • enableFrontendTls11 (bool) - Should TLS 1.1 be enabled on the frontend of the gateway? Defaults to false.

  • enableTripleDesCiphers (bool) - Should the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)? Defaults to false.

sign_in: pulumi.Output[dict] = None

A sign_in block as defined below.

  • enabled (bool) - Should anonymous users be redirected to the sign in page?

sign_up: pulumi.Output[dict] = None

A sign_up block as defined below.

  • enabled (bool) - Can users sign up on the development portal?

  • termsOfService (dict) - A terms_of_service block as defined below.

    • consentRequired (bool) - Should the user be asked for consent during sign up?

    • enabled (bool) - Should Terms of Service be displayed during sign up?.

    • text (str) - The Terms of Service which users are required to agree to in order to sign up.

sku_name: pulumi.Output[str] = None

sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

tags: pulumi.Output[dict] = None

A mapping of tags assigned to the resource.

virtual_network_configuration: pulumi.Output[dict] = None

A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

  • subnet_id (str) - The id of the subnet that will be used for the API Management.

virtual_network_type: pulumi.Output[str] = None

The type of virtual network you want to use, valid values include: None, External, Internal.

static get(resource_name, id, opts=None, additional_locations=None, certificates=None, developer_portal_url=None, gateway_regional_url=None, gateway_url=None, hostname_configuration=None, identity=None, location=None, management_api_url=None, name=None, notification_sender_email=None, policy=None, portal_url=None, private_ip_addresses=None, protocols=None, public_ip_addresses=None, publisher_email=None, publisher_name=None, resource_group_name=None, scm_url=None, security=None, sign_in=None, sign_up=None, sku_name=None, tags=None, virtual_network_configuration=None, virtual_network_type=None)

Get an existing Service resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • additional_locations (pulumi.Input[list]) – One or more additional_location blocks as defined below.

  • certificates (pulumi.Input[list]) – One or more (up to 10) certificate blocks as defined below.

  • developer_portal_url (pulumi.Input[str]) – The URL for the Developer Portal associated with this API Management service.

  • gateway_regional_url (pulumi.Input[str]) – The URL of the Regional Gateway for the API Management Service in the specified region.

  • gateway_url (pulumi.Input[str]) – The URL of the Gateway for the API Management Service.

  • 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.

  • management_api_url (pulumi.Input[str]) – The URL for the Management API associated with this API Management service.

  • 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.

  • policy (pulumi.Input[dict]) – A policy block as defined below.

  • portal_url (pulumi.Input[str]) – The URL for the Publisher Portal associated with this API Management service.

  • protocols (pulumi.Input[dict]) – A protocols block as defined below.

  • public_ip_addresses (pulumi.Input[list]) – 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 (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.

  • scm_url (pulumi.Input[str]) – The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

  • security (pulumi.Input[dict]) – A security block as defined below.

  • sign_in (pulumi.Input[dict]) – A sign_in block as defined below.

  • sign_up (pulumi.Input[dict]) – A sign_up block as defined below.

  • sku_name (pulumi.Input[str]) – sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

  • tags (pulumi.Input[dict]) – A mapping of tags assigned to the resource.

  • virtual_network_configuration (pulumi.Input[dict]) – A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

  • virtual_network_type (pulumi.Input[str]) – The type of virtual network you want to use, valid values include: None, External, Internal.

The additional_locations object supports the following:

  • gateway_regional_url (pulumi.Input[str]) - The URL of the Regional Gateway for the API Management Service in the specified region.

  • location (pulumi.Input[str]) - The name of the Azure Region in which the API Management Service should be expanded to.

  • public_ip_addresses (pulumi.Input[list]) - Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.

The certificates object supports the following:

  • certificatePassword (pulumi.Input[str]) - The password for the certificate.

  • encodedCertificate (pulumi.Input[str]) - The Base64 Encoded PFX Certificate.

  • storeName (pulumi.Input[str]) - The name of the Certificate Store where this certificate should be stored. Possible values are CertificateAuthority and Root.

The hostname_configuration object supports the following:

  • developerPortals (pulumi.Input[list]) - One or more developer_portal blocks as documented below.

    • certificate (pulumi.Input[str]) - One or more (up to 10) certificate blocks as defined below.

    • certificatePassword (pulumi.Input[str]) - The password for the certificate.

    • host_name (pulumi.Input[str]) - The Hostname to use for the Management API.

    • key_vault_id (pulumi.Input[str]) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (pulumi.Input[bool]) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • managements (pulumi.Input[list]) - One or more management blocks as documented below.

    • certificate (pulumi.Input[str]) - The Base64 Encoded Certificate.

    • certificatePassword (pulumi.Input[str]) - The password associated with the certificate provided above.

    • host_name (pulumi.Input[str]) - The Hostname to use for the Management API.

    • key_vault_id (pulumi.Input[str]) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (pulumi.Input[bool]) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • portals (pulumi.Input[list]) - One or more portal blocks as documented below.

    • certificate (pulumi.Input[str]) - One or more (up to 10) certificate blocks as defined below.

    • certificatePassword (pulumi.Input[str]) - The password for the certificate.

    • host_name (pulumi.Input[str]) - The Hostname to use for the Management API.

    • key_vault_id (pulumi.Input[str]) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (pulumi.Input[bool]) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • proxies (pulumi.Input[list]) - One or more proxy blocks as documented below.

    • certificate (pulumi.Input[str]) - The Base64 Encoded Certificate.

    • certificatePassword (pulumi.Input[str]) - The password associated with the certificate provided above.

    • defaultSslBinding (pulumi.Input[bool]) - Is the certificate associated with this Hostname the Default SSL Certificate? This is used when an SNI header isn’t specified by a client. Defaults to false.

    • host_name (pulumi.Input[str]) - The Hostname to use for the Management API.

    • key_vault_id (pulumi.Input[str]) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (pulumi.Input[bool]) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

  • scms (pulumi.Input[list]) - One or more scm blocks as documented below.

    • certificate (pulumi.Input[str]) - One or more (up to 10) certificate blocks as defined below.

    • certificatePassword (pulumi.Input[str]) - The password for the certificate.

    • host_name (pulumi.Input[str]) - The Hostname to use for the Management API.

    • key_vault_id (pulumi.Input[str]) - The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

    • negotiateClientCertificate (pulumi.Input[bool]) - Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

The identity object supports the following:

  • identityIds (pulumi.Input[list]) - A list of IDs for User Assigned Managed Identity resources to be assigned.

  • principal_id (pulumi.Input[str]) - The Principal ID associated with this Managed Service Identity.

  • tenant_id (pulumi.Input[str]) - The Tenant ID associated with this Managed Service Identity.

  • type (pulumi.Input[str]) - Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned (to enable both).

The policy object supports the following:

  • xml_content (pulumi.Input[str]) - The XML Content for this Policy.

  • xml_link (pulumi.Input[str]) - A link to an API Management Policy XML Document, which must be publicly available.

The protocols object supports the following:

  • enable_http2 (pulumi.Input[bool]) - Should HTTP/2 be supported by the API Management Service? Defaults to false.

The security object supports the following:

  • enableBackendSsl30 (pulumi.Input[bool]) - Should SSL 3.0 be enabled on the backend of the gateway? Defaults to false.

  • enableBackendTls10 (pulumi.Input[bool]) - Should TLS 1.0 be enabled on the backend of the gateway? Defaults to false.

  • enableBackendTls11 (pulumi.Input[bool]) - Should TLS 1.1 be enabled on the backend of the gateway? Defaults to false.

  • enableFrontendSsl30 (pulumi.Input[bool]) - Should SSL 3.0 be enabled on the frontend of the gateway? Defaults to false.

  • enableFrontendTls10 (pulumi.Input[bool]) - Should TLS 1.0 be enabled on the frontend of the gateway? Defaults to false.

  • enableFrontendTls11 (pulumi.Input[bool]) - Should TLS 1.1 be enabled on the frontend of the gateway? Defaults to false.

  • enableTripleDesCiphers (pulumi.Input[bool]) - Should the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)? Defaults to false.

The sign_in object supports the following:

  • enabled (pulumi.Input[bool]) - Should anonymous users be redirected to the sign in page?

The sign_up object supports the following:

  • enabled (pulumi.Input[bool]) - Can users sign up on the development portal?

  • termsOfService (pulumi.Input[dict]) - A terms_of_service block as defined below.

    • consentRequired (pulumi.Input[bool]) - Should the user be asked for consent during sign up?

    • enabled (pulumi.Input[bool]) - Should Terms of Service be displayed during sign up?.

    • text (pulumi.Input[str]) - The Terms of Service which users are required to agree to in order to sign up.

The virtual_network_configuration object supports the following:

  • subnet_id (pulumi.Input[str]) - The id of the subnet that will be used for the API Management.

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.Subscription(resource_name, opts=None, api_management_name=None, display_name=None, primary_key=None, product_id=None, resource_group_name=None, secondary_key=None, state=None, subscription_id=None, user_id=None, __props__=None, __name__=None, __opts__=None)

Manages a Subscription within a API Management Service.

import pulumi
import pulumi_azure as azure

example_service = azure.apimanagement.get_service(name="example-apim",
    resource_group_name="example-resources")
example_product = azure.apimanagement.get_product(product_id="00000000-0000-0000-0000-000000000000",
    api_management_name=example_service.name,
    resource_group_name=example_service.resource_group_name)
example_user = azure.apimanagement.get_user(user_id="11111111-1111-1111-1111-111111111111",
    api_management_name=example_service.name,
    resource_group_name=example_service.resource_group_name)
example_subscription = azure.apimanagement.Subscription("exampleSubscription",
    api_management_name=example_service.name,
    resource_group_name=example_service.resource_group_name,
    user_id=example_user.id,
    product_id=example_product.id,
    display_name="Parser API")
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 where this Subscription should be created. Changing this forces a new resource to be created.

  • display_name (pulumi.Input[str]) – The display name of this Subscription.

  • product_id (pulumi.Input[str]) – The ID of the Product which should be assigned to this Subscription. 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.

  • state (pulumi.Input[str]) – The state of this Subscription. Possible values are active, cancelled, expired, rejected, submitted and suspended. Defaults to submitted.

  • subscription_id (pulumi.Input[str]) – 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.

  • user_id (pulumi.Input[str]) – The ID of the User which should be assigned to this Subscription. Changing this forces a new resource to be created.

api_management_name: pulumi.Output[str] = None

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

display_name: pulumi.Output[str] = None

The display name of this Subscription.

product_id: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

state: pulumi.Output[str] = None

The state of this Subscription. Possible values are active, cancelled, expired, rejected, submitted and suspended. Defaults to submitted.

subscription_id: pulumi.Output[str] = None

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.

user_id: pulumi.Output[str] = None

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

static get(resource_name, id, opts=None, api_management_name=None, display_name=None, primary_key=None, product_id=None, resource_group_name=None, secondary_key=None, state=None, subscription_id=None, user_id=None)

Get an existing Subscription resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_management_name (pulumi.Input[str]) – The name of the API Management Service where this Subscription should be created. Changing this forces a new resource to be created.

  • display_name (pulumi.Input[str]) – The display name of this Subscription.

  • product_id (pulumi.Input[str]) – The ID of the Product which should be assigned to this Subscription. 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.

  • state (pulumi.Input[str]) – The state of this Subscription. Possible values are active, cancelled, expired, rejected, submitted and suspended. Defaults to submitted.

  • subscription_id (pulumi.Input[str]) – 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.

  • user_id (pulumi.Input[str]) – The ID of the User which should be assigned to this Subscription. 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.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, __props__=None, __name__=None, __opts__=None)

Manages an API Management User.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
example_user = azure.apimanagement.User("exampleUser",
    user_id="5931a75ae4bbd512288c680b",
    api_management_name=example_service.name,
    resource_group_name=example_resource_group.name,
    first_name="Example",
    last_name="User",
    email="user@example.com",
    state="active")
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: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None

The email address associated with this user.

first_name: pulumi.Output[str] = None

The first name for this user.

last_name: pulumi.Output[str] = None

The last name for this user.

note: pulumi.Output[str] = None

A note about this user.

password: pulumi.Output[str] = None

The password associated with this user.

resource_group_name: pulumi.Output[str] = None

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

state: pulumi.Output[str] = None

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

user_id: pulumi.Output[str] = None

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

static get(resource_name, id, 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)

Get an existing User resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

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(api_management_name=None, name=None, resource_group_name=None, revision=None, opts=None)

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

import pulumi
import pulumi_azure as azure

example = azure.apimanagement.get_api(name="search-api",
    api_management_name="search-api-management",
    resource_group_name="search-service",
    revision="2")
pulumi.export("apiManagementApiId", example.id)
Parameters
  • api_management_name (str) – The name of the API Management Service in which the API Management API exists.

  • name (str) – The name of the API Management API.

  • resource_group_name (str) – The Name of the Resource Group in which the API Management Service exists.

  • revision (str) – The Revision of the API Management API.

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

Uses this data source to access information about an API Version Set within an API Management Service.

import pulumi
import pulumi_azure as azure

example = azure.apimanagement.get_api_version_set(resource_group_name="example-resources",
    api_management_name="example-api",
    name="example-api-version-set")
pulumi.export("apiManagementApiVersionSetId", example.id)
Parameters
  • api_management_name (str) – The name of the API Management Service where the API Version Set exists.

  • name (str) – The name of the API Version Set.

  • resource_group_name (str) – The name of the Resource Group in which the parent API Management Service exists.

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.

import pulumi
import pulumi_azure as azure

example = azure.apimanagement.get_group(name="my-group",
    api_management_name="example-apim",
    resource_group_name="search-service")
pulumi.export("groupType", example.type)
Parameters
  • api_management_name (str) – The Name of the API Management Service in which this Group exists.

  • name (str) – The Name of the API Management Group.

  • resource_group_name (str) – The Name of the Resource Group in which the API Management Service exists.

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.

import pulumi
import pulumi_azure as azure

example = azure.apimanagement.get_product(product_id="my-product",
    api_management_name="example-apim",
    resource_group_name="search-service")
pulumi.export("productTerms", example.terms)
Parameters
  • api_management_name (str) – The Name of the API Management Service in which this Product exists.

  • product_id (str) – The Identifier for the API Management Product.

  • resource_group_name (str) – The Name of the Resource Group in which the API Management Service exists.

pulumi_azure.apimanagement.get_service(name=None, resource_group_name=None, opts=None)

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

import pulumi
import pulumi_azure as azure

example = azure.apimanagement.get_service(name="search-api",
    resource_group_name="search-service")
pulumi.export("apiManagementId", example.id)
Parameters
  • name (str) – The name of the API Management service.

  • resource_group_name (str) – The Name of the Resource Group in which the API Management Service exists.

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.

Parameters
  • api_management_name (str) – The Name of the API Management Service in which this User exists.

  • resource_group_name (str) – The Name of the Resource Group in which the API Management Service exists.

  • user_id (str) – The Identifier for the User.