apimanagement

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

Manages an API 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 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.

api_management_name = None

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

description = None

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

display_name = None

The display name of the API.

import_ = None

A import block as documented below.

is_current = None

Is this the current API Revision?

is_online = None

Is this API Revision online/accessible via the Gateway?

name = None

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

path = 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 = None

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

resource_group_name = None

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

revision = None

The Revision which used for this API.

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? Defaults to false.

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.

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

Manages an API Operation 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 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.
api_management_name = None

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

api_name = 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 = None

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

display_name = None

The Display Name for this API Management Operation.

method = None

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

operation_id = None

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

request = None

A request block as defined below.

resource_group_name = None

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

responses = None

One or more response blocks as defined below.

template_parameters = None

One or more template_parameter blocks as defined below.

url_template = None

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

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

Manages an API Management API Operation 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 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 = None

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

api_name = 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 = 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 = None

The XML Content for this Policy.

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, __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.
  • xml_link (pulumi.Input[str]) – A link to a Policy XML Document, which must be publicly available.
api_management_name = None

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

api_name = 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 = 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 = None

The XML Content for this Policy.

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

Manages an API Schema 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 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 = None

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

api_name = 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 = None

The content type of the API Schema.

resource_group_name = None

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

schema_id = None

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

value = None

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

Manages an API Version Set within a 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 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 = 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 = None

The description of API Version Set.

display_name = None

The display name of this API Version Set.

name = None

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

resource_group_name = 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 = 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.

versioning_scheme = None

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

Manages an Authorization Server 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 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.
api_management_name = 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 = None

The OAUTH Authorization Endpoint.

authorization_methods = 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 = None

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

client_authentication_methods = None

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

client_id = None

The Client/App ID registered with this Authorization Server.

client_registration_endpoint = None

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

client_secret = None

The Client/App Secret registered with this Authorization Server.

default_scope = None

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

description = None

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

display_name = None

The user-friendly name of this Authorization Server.

grant_types = None

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

name = None

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

resource_group_name = None

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

resource_owner_password = None

The password associated with the Resource Owner.

resource_owner_username = None

The username associated with the Resource Owner.

support_state = 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 = None

The OAUTH Token Endpoint.

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, __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 = None

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

data = None

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

expiration = None

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

name = None

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

password = None

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

resource_group_name = None

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

subject = None

The Subject of this Certificate.

thumbprint = None

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.GetApiResult(api_management_name=None, description=None, display_name=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, 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.

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.

id = None

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

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

A collection of values returned by getGroup.

description = None

The description of this API Management Group.

display_name = None

The display name of this API Management Group.

external_id = None

The identifier of the external Group.

type = None

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

id = None

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

class pulumi_azure.apimanagement.GetProductResult(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, id=None)

A collection of values returned by getProduct.

approval_required = None

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

description = None

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

display_name = None

The Display Name for this API Management Product.

published = None

Is this Product Published?

subscription_required = None

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

subscriptions_limit = None

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

terms = None

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

id = None

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

class pulumi_azure.apimanagement.GetServiceResult(additional_locations=None, gateway_regional_url=None, gateway_url=None, hostname_configurations=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=None, tags=None, id=None)

A collection of values returned by getService.

additional_locations = None

One or more additional_location blocks as defined below

gateway_regional_url = None

Gateway URL of the API Management service in the Region.

gateway_url = None

The URL for the API Management Service’s Gateway.

hostname_configurations = None

A hostname_configuration block as defined below.

location = None

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

management_api_url = None

The URL for the Management API.

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.

sku = None

A sku block as documented below.

tags = None

A mapping of tags assigned to the resource.

id = None

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

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

A collection of values returned by getUser.

email = None

The Email Address used for this User.

first_name = None

The First Name for the User.

last_name = None

The Last Name for the User.

note = None

Any notes about this User.

state = None

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

id = None

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

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

Manages an API Management Group.

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

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

description = None

The description of this API Management Group.

display_name = None

The display name of this API Management Group.

external_id = None

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

name = None

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

resource_group_name = None

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

type = None

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

translate_output_property(prop)

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

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

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

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

Manages an API Management User Assignment to a Group.

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

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

group_name = None

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

resource_group_name = None

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

user_id = None

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

translate_output_property(prop)

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

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

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

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.apimanagement.Logger(resource_name, opts=None, api_management_name=None, application_insights=None, buffered=None, description=None, eventhub=None, name=None, resource_group_name=None, __name__=None, __opts__=None)

Manages a Logger 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. 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.
api_management_name = None

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

application_insights = None

An application_insights block as documented below.

buffered = None

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

description = None

A description of this Logger.

eventhub = None

An eventhub block as documented below.

name = 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 = None

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

translate_output_property(prop)

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

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

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

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.apimanagement.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, __name__=None, __opts__=None)

Manages an OpenID Connect Provider within a 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 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 = 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 = None

The Client ID used for the Client Application.

client_secret = None

The Client Secret used for the Client Application.

description = None

A description of this OpenID Connect Provider.

display_name = None

A user-friendly name for this OpenID Connect Provider.

metadata_endpoint = None

The URI of the Metadata endpoint.

name = 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 = None

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

Manages an API Management Product.

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

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

approval_required = None

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

description = None

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

display_name = None

The Display Name for this API Management Product.

product_id = None

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

published = None

Is this Product Published?

resource_group_name = None

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

subscription_required = None

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

subscriptions_limit = None

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

terms = None

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

translate_output_property(prop)

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

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

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

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

Manages an API Management API Assignment to a Product.

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

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

api_name = None

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

product_id = 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 = None

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

translate_output_property(prop)

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

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

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

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

Manages an API Management Product Assignment to a Group.

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

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

group_name = None

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

product_id = 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 = None

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

translate_output_property(prop)

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

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

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

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

Manages an API Management Product 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.
  • 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 = None

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

product_id = 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 = 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 = None

The XML Content for this Policy.

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

Manages an API Management Property.

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

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

display_name = None

The display name of this API Management Property.

name = None

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

resource_group_name = None

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

secret = None

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

tags = None

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

value = None

The value of this API Management Property.

translate_output_property(prop)

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

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

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

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.apimanagement.Service(resource_name, opts=None, additional_location=None, certificates=None, hostname_configuration=None, identity=None, location=None, name=None, notification_sender_email=None, policy=None, publisher_email=None, publisher_name=None, resource_group_name=None, security=None, sign_in=None, sign_up=None, sku=None, tags=None, __name__=None, __opts__=None)

Manages an API Management Service.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • additional_location (pulumi.Input[dict]) – One or more additional_location blocks as defined below.
  • certificates (pulumi.Input[list]) – One or more (up to 10) certificate blocks as defined below.
  • hostname_configuration (pulumi.Input[dict]) – A hostname_configuration block as defined below.
  • identity (pulumi.Input[dict]) – An identity block is documented below.
  • location (pulumi.Input[str]) – The Azure location where the API Management Service exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the API Management Service. Changing this forces a new resource to be created.
  • notification_sender_email (pulumi.Input[str]) – Email address from which the notification will be sent.
  • policy (pulumi.Input[dict]) – A policy 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 (pulumi.Input[dict]) – A sku block as documented below.
  • tags (pulumi.Input[dict]) – A mapping of tags assigned to the resource.
additional_location = None

One or more additional_location blocks as defined below.

certificates = None

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

gateway_regional_url = None

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

gateway_url = None

The URL of the Gateway for the API Management Service.

hostname_configuration = None

A hostname_configuration block as defined below.

identity = None

An identity block is documented below.

location = None

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

management_api_url = None

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

name = None

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

notification_sender_email = None

Email address from which the notification will be sent.

policy = None

A policy block as defined below.

portal_url = None

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

public_ip_addresses = None

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

publisher_email = None

The email of publisher/company.

publisher_name = None

The name of publisher/company.

resource_group_name = None

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

scm_url = None

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

security = None

A security block as defined below.

sign_in = None

A sign_in block as defined below.

sign_up = None

A sign_up block as defined below.

sku = None

A sku block as documented below.

tags = None

A mapping of tags assigned to the resource.

translate_output_property(prop)

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

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

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

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.apimanagement.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, __name__=None, __opts__=None)

Manages a Subscription within a 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 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 = 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 = None

The display name of this Subscription.

product_id = 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 = None

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

state = None

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

subscription_id = 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 = None

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

Manages an API Management User.

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

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

confirmation = None

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

email = None

The email address associated with this user.

first_name = None

The first name for this user.

last_name = None

The last name for this user.

note = None

A note about this user.

password = None

The password associated with this user.

resource_group_name = None

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

state = None

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

user_id = None

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

translate_output_property(prop)

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

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

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

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_azure.apimanagement.get_api(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.

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

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

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

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

pulumi_azure.apimanagement.get_service(name=None, resource_group_name=None, opts=None)

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

pulumi_azure.apimanagement.get_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.