1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. apimanagement

Module apimanagement

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.

Resources

Functions

Others

Resources

Resource Api

class Api extends CustomResource

Manages an API within an API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
const exampleApi = new azure.apimanagement.Api("exampleApi", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    revision: "1",
    displayName: "Example API",
    path: "example",
    protocols: ["https"],
    "import": {
        contentFormat: "swagger-link-json",
        contentValue: "http://conferenceapi.azurewebsites.net/?format=json",
    },
});

constructor

new Api(name: string, args: ApiArgs, opts?: pulumi.CustomResourceOptions)

Create a Api resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiState, opts?: pulumi.CustomResourceOptions): Api

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Api

Returns true if the given object is an instance of Api. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property description

public description: pulumi.Output<string | undefined>;

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

property displayName

public displayName: pulumi.Output<string>;

The display name of the API.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property import

public import: pulumi.Output<ApiImport | undefined>;

A import block as documented below.

property isCurrent

public isCurrent: pulumi.Output<boolean>;

Is this the current API Revision?

property isOnline

public isOnline: pulumi.Output<boolean>;

Is this API Revision online/accessible via the Gateway?

property name

public name: pulumi.Output<string>;

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

property path

public path: pulumi.Output<string>;

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.

property protocols

public protocols: pulumi.Output<string[]>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property revision

public revision: pulumi.Output<string>;

The Revision which used for this API.

property serviceUrl

public serviceUrl: pulumi.Output<string>;

Absolute URL of the backend service implementing this API.

property soapPassThrough

public soapPassThrough: pulumi.Output<boolean | undefined>;

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

property subscriptionKeyParameterNames

public subscriptionKeyParameterNames: pulumi.Output<ApiSubscriptionKeyParameterNames>;

A subscriptionKeyParameterNames block as documented below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<string>;

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

property versionSetId

public versionSetId: pulumi.Output<string>;

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

Resource ApiOperation

class ApiOperation extends CustomResource

Manages an API Operation within an API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleApi = azure.apimanagement.getApi({
    name: "search-api",
    apiManagementName: "search-api-management",
    resourceGroupName: "search-service",
    revision: "2",
});
const exampleApiOperation = new azure.apimanagement.ApiOperation("exampleApiOperation", {
    operationId: "user-delete",
    apiName: exampleApi.then(exampleApi => exampleApi.name),
    apiManagementName: exampleApi.then(exampleApi => exampleApi.apiManagementName),
    resourceGroupName: exampleApi.then(exampleApi => exampleApi.resourceGroupName),
    displayName: "Delete User Operation",
    method: "DELETE",
    urlTemplate: "/users/{id}/delete",
    description: "This can only be done by the logged in user.",
    response: [{
        statusCode: 200,
    }],
});

constructor

new ApiOperation(name: string, args: ApiOperationArgs, opts?: pulumi.CustomResourceOptions)

Create a ApiOperation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiOperationState, opts?: pulumi.CustomResourceOptions): ApiOperation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApiOperation

Returns true if the given object is an instance of ApiOperation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property apiName

public apiName: pulumi.Output<string>;

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.

property description

public description: pulumi.Output<string | undefined>;

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

property displayName

public displayName: pulumi.Output<string>;

The Display Name for this API Management Operation.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property method

public method: pulumi.Output<string>;

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

property operationId

public operationId: pulumi.Output<string>;

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

property request

public request: pulumi.Output<ApiOperationRequest>;

A request block as defined below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property responses

public responses: pulumi.Output<ApiOperationResponse[] | undefined>;

One or more response blocks as defined below.

property templateParameters

public templateParameters: pulumi.Output<ApiOperationTemplateParameter[] | undefined>;

One or more templateParameter blocks as defined below.

property urlTemplate

public urlTemplate: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ApiOperationPolicy

class ApiOperationPolicy extends CustomResource

Manages an API Management API Operation Policy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleApiOperation = new azure.apimanagement.ApiOperation("exampleApiOperation", {});
//...
const exampleApiOperationPolicy = new azure.apimanagement.ApiOperationPolicy("exampleApiOperationPolicy", {
    apiName: exampleApiOperation.apiName,
    apiManagementName: exampleApiOperation.apiManagementName,
    resourceGroupName: exampleApiOperation.resourceGroupName,
    operationId: exampleApiOperation.operationId,
    xmlContent: `<policies>
  <inbound>
    <find-and-replace from="xyz" to="abc" />
  </inbound>
</policies>
`,
});

constructor

new ApiOperationPolicy(name: string, args: ApiOperationPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a ApiOperationPolicy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiOperationPolicyState, opts?: pulumi.CustomResourceOptions): ApiOperationPolicy

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApiOperationPolicy

Returns true if the given object is an instance of ApiOperationPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property apiName

public apiName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property operationId

public operationId: pulumi.Output<string>;

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property xmlContent

public xmlContent: pulumi.Output<string>;

The XML Content for this Policy.

public xmlLink: pulumi.Output<string | undefined>;

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

Resource ApiPolicy

class ApiPolicy extends CustomResource

Manages an API Management API Policy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleApi = pulumi.output(azure.apimanagement.getApi({
    apiManagementName: "example-apim",
    apiName: "my-api",
    resourceGroupName: "search-service",
}, { async: true }));
const exampleApiPolicy = new azure.apimanagement.ApiPolicy("example", {
    apiManagementName: exampleApi.apiManagementName,
    apiName: exampleApi.name,
    resourceGroupName: exampleApi.resourceGroupName,
    xmlContent: `<policies>
  <inbound>
    <find-and-replace from="xyz" to="abc" />
  </inbound>
</policies>
`,
});

constructor

new ApiPolicy(name: string, args: ApiPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a ApiPolicy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiPolicyState, opts?: pulumi.CustomResourceOptions): ApiPolicy

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApiPolicy

Returns true if the given object is an instance of ApiPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property apiName

public apiName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property xmlContent

public xmlContent: pulumi.Output<string>;

The XML Content for this Policy as a string.

public xmlLink: pulumi.Output<string | undefined>;

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

Resource ApiSchema

class ApiSchema extends CustomResource

Manages an API Schema within an API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * from "fs";

const exampleApi = azure.apimanagement.getApi({
    name: "search-api",
    apiManagementName: "search-api-management",
    resourceGroupName: "search-service",
    revision: "2",
});
const exampleApiSchema = new azure.apimanagement.ApiSchema("exampleApiSchema", {
    apiName: exampleApi.then(exampleApi => exampleApi.name),
    apiManagementName: exampleApi.then(exampleApi => exampleApi.apiManagementName),
    resourceGroupName: exampleApi.then(exampleApi => exampleApi.resourceGroupName),
    schemaId: "example-sche,a",
    contentType: "application/vnd.ms-azure-apim.xsd+xml",
    value: fs.readFileSync("api_management_api_schema.xml"),
});

constructor

new ApiSchema(name: string, args: ApiSchemaArgs, opts?: pulumi.CustomResourceOptions)

Create a ApiSchema resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiSchemaState, opts?: pulumi.CustomResourceOptions): ApiSchema

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApiSchema

Returns true if the given object is an instance of ApiSchema. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property apiName

public apiName: pulumi.Output<string>;

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.

property contentType

public contentType: pulumi.Output<string>;

The content type of the API Schema.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property schemaId

public schemaId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The JSON escaped string defining the document representing the Schema.

Resource ApiVersionSet

class ApiVersionSet extends CustomResource

Manages an API Version Set within an API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Developer_1",
});
const exampleApiVersionSet = new azure.apimanagement.ApiVersionSet("exampleApiVersionSet", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    displayName: "ExampleAPIVersionSet",
    versioningScheme: "Segment",
});

constructor

new ApiVersionSet(name: string, args: ApiVersionSetArgs, opts?: pulumi.CustomResourceOptions)

Create a ApiVersionSet resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiVersionSetState, opts?: pulumi.CustomResourceOptions): ApiVersionSet

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApiVersionSet

Returns true if the given object is an instance of ApiVersionSet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property description

public description: pulumi.Output<string | undefined>;

The description of API Version Set.

property displayName

public displayName: pulumi.Output<string>;

The display name of this API Version Set.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property versionHeaderName

public versionHeaderName: pulumi.Output<string | undefined>;

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

property versionQueryName

public versionQueryName: pulumi.Output<string | undefined>;

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

property versioningScheme

public versioningScheme: pulumi.Output<string>;

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

Resource AuthorizationServer

class AuthorizationServer extends CustomResource

Manages an Authorization Server within an API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleApi = azure.apimanagement.getApi({
    name: "search-api",
    apiManagementName: "search-api-management",
    resourceGroupName: "search-service",
    revision: "2",
});
const exampleAuthorizationServer = new azure.apimanagement.AuthorizationServer("exampleAuthorizationServer", {
    apiManagementName: data.azurerm_api_management.example.name,
    resourceGroupName: data.azurerm_api_management.example.resource_group_name,
    displayName: "Test Server",
    authorizationEndpoint: "https://example.mydomain.com/client/authorize",
    clientId: "42424242-4242-4242-4242-424242424242",
    clientRegistrationEndpoint: "https://example.mydomain.com/client/register",
    grantTypes: ["authorizationCode"],
});

constructor

new AuthorizationServer(name: string, args: AuthorizationServerArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthorizationServer resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthorizationServerState, opts?: pulumi.CustomResourceOptions): AuthorizationServer

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AuthorizationServer

Returns true if the given object is an instance of AuthorizationServer. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property authorizationEndpoint

public authorizationEndpoint: pulumi.Output<string>;

The OAUTH Authorization Endpoint.

property authorizationMethods

public authorizationMethods: pulumi.Output<string[]>;

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

property bearerTokenSendingMethods

public bearerTokenSendingMethods: pulumi.Output<string[] | undefined>;

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

property clientAuthenticationMethods

public clientAuthenticationMethods: pulumi.Output<string[] | undefined>;

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

property clientId

public clientId: pulumi.Output<string>;

The Client/App ID registered with this Authorization Server.

property clientRegistrationEndpoint

public clientRegistrationEndpoint: pulumi.Output<string>;

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

property clientSecret

public clientSecret: pulumi.Output<string | undefined>;

The Client/App Secret registered with this Authorization Server.

property defaultScope

public defaultScope: pulumi.Output<string | undefined>;

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

property description

public description: pulumi.Output<string | undefined>;

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

property displayName

public displayName: pulumi.Output<string>;

The user-friendly name of this Authorization Server.

property grantTypes

public grantTypes: pulumi.Output<string[]>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property resourceOwnerPassword

public resourceOwnerPassword: pulumi.Output<string | undefined>;

The password associated with the Resource Owner.

property resourceOwnerUsername

public resourceOwnerUsername: pulumi.Output<string | undefined>;

The username associated with the Resource Owner.

property supportState

public supportState: pulumi.Output<boolean | undefined>;

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

property tokenBodyParameters

public tokenBodyParameters: pulumi.Output<AuthorizationServerTokenBodyParameter[] | undefined>;

property tokenEndpoint

public tokenEndpoint: pulumi.Output<string | undefined>;

The OAUTH Token Endpoint.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Backend

class Backend extends CustomResource

Manages a backend within an API Management Service.

constructor

new Backend(name: string, args: BackendArgs, opts?: pulumi.CustomResourceOptions)

Create a Backend resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BackendState, opts?: pulumi.CustomResourceOptions): Backend

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Backend

Returns true if the given object is an instance of Backend. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property credentials

public credentials: pulumi.Output<BackendCredentials | undefined>;

A credentials block as documented below.

property description

public description: pulumi.Output<string | undefined>;

The description of the backend.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property protocol

public protocol: pulumi.Output<string>;

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

property proxy

public proxy: pulumi.Output<BackendProxy | undefined>;

A proxy block as documented below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property resourceId

public resourceId: pulumi.Output<string | undefined>;

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.

property serviceFabricCluster

public serviceFabricCluster: pulumi.Output<BackendServiceFabricCluster | undefined>;

A serviceFabricCluster block as documented below.

property title

public title: pulumi.Output<string | undefined>;

The title of the backend.

property tls

public tls: pulumi.Output<BackendTls | undefined>;

A tls block as documented below.

property url

public url: pulumi.Output<string>;

The URL of the backend host.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Certificate

class Certificate extends CustomResource

Manages an Certificate within an API Management Service.

constructor

new Certificate(name: string, args: CertificateArgs, opts?: pulumi.CustomResourceOptions)

Create a Certificate resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CertificateState, opts?: pulumi.CustomResourceOptions): Certificate

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Certificate

Returns true if the given object is an instance of Certificate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property data

public data: pulumi.Output<string>;

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

property expiration

public expiration: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property password

public password: pulumi.Output<string | undefined>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property subject

public subject: pulumi.Output<string>;

The Subject of this Certificate.

property thumbprint

public thumbprint: pulumi.Output<string>;

The Thumbprint of this Certificate.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Diagnostic

class Diagnostic extends CustomResource

Manages an API Management Service Diagnostic.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleInsights = new azure.appinsights.Insights("exampleInsights", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    applicationType: "web",
});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@mycompany.io",
    skuName: "Developer_1",
});
const exampleLogger = new azure.apimanagement.Logger("exampleLogger", {
    apiManagementName: exampleService.name,
    resourceGroupName: exampleResourceGroup.name,
    application_insights: {
        instrumentationKey: exampleInsights.instrumentationKey,
    },
});
const exampleDiagnostic = new azure.apimanagement.Diagnostic("exampleDiagnostic", {
    identifier: "applicationinsights",
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    apiManagementLoggerId: exampleLogger.id,
});

constructor

new Diagnostic(name: string, args: DiagnosticArgs, opts?: pulumi.CustomResourceOptions)

Create a Diagnostic resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DiagnosticState, opts?: pulumi.CustomResourceOptions): Diagnostic

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Diagnostic

Returns true if the given object is an instance of Diagnostic. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementLoggerId

public apiManagementLoggerId: pulumi.Output<string>;

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

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property enabled

DEPRECATED this property has been removed from the API and will be removed in version 3.0 of the provider
public enabled: pulumi.Output<boolean | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identifier

public identifier: pulumi.Output<string>;

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.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Group

class Group extends CustomResource

Manages an API Management Group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Developer_1",
});
const exampleGroup = new azure.apimanagement.Group("exampleGroup", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    displayName: "Example Group",
    description: "This is an example API management group.",
});

constructor

new Group(name: string, args: GroupArgs, opts?: pulumi.CustomResourceOptions)

Create a Group resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupState, opts?: pulumi.CustomResourceOptions): Group

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Group

Returns true if the given object is an instance of Group. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property description

public description: pulumi.Output<string | undefined>;

The description of this API Management Group.

property displayName

public displayName: pulumi.Output<string>;

The display name of this API Management Group.

property externalId

public externalId: pulumi.Output<string | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property type

public type: pulumi.Output<string | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource GroupUser

class GroupUser extends CustomResource

Manages an API Management User Assignment to a Group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleUser = azure.apimanagement.getUser({
    userId: "my-user",
    apiManagementName: "example-apim",
    resourceGroupName: "search-service",
});
const exampleGroupUser = new azure.apimanagement.GroupUser("exampleGroupUser", {
    userId: exampleUser.then(exampleUser => exampleUser.id),
    groupName: "example-group",
    resourceGroupName: exampleUser.then(exampleUser => exampleUser.resourceGroupName),
    apiManagementName: exampleUser.then(exampleUser => exampleUser.apiManagementName),
});

constructor

new GroupUser(name: string, args: GroupUserArgs, opts?: pulumi.CustomResourceOptions)

Create a GroupUser resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupUserState, opts?: pulumi.CustomResourceOptions): GroupUser

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GroupUser

Returns true if the given object is an instance of GroupUser. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property groupName

public groupName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string>;

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.

Resource IdentityProviderAad

class IdentityProviderAad extends CustomResource

Manages an API Management AAD Identity Provider.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@mycompany.io",
    skuName: "Developer_1",
});
const exampleIdentityProviderAad = new azure.apimanagement.IdentityProviderAad("exampleIdentityProviderAad", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    clientId: "00000000-0000-0000-0000-000000000000",
    clientSecret: "00000000000000000000000000000000",
    allowedTenants: ["00000000-0000-0000-0000-000000000000"],
});

constructor

new IdentityProviderAad(name: string, args: IdentityProviderAadArgs, opts?: pulumi.CustomResourceOptions)

Create a IdentityProviderAad resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IdentityProviderAadState, opts?: pulumi.CustomResourceOptions): IdentityProviderAad

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IdentityProviderAad

Returns true if the given object is an instance of IdentityProviderAad. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowedTenants

public allowedTenants: pulumi.Output<string[]>;

List of allowed AAD Tenants.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property clientId

public clientId: pulumi.Output<string>;

Client Id of the Application in the AAD Identity Provider.

property clientSecret

public clientSecret: pulumi.Output<string>;

Client secret of the Application in the AAD Identity Provider.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource IdentityProviderFacebook

class IdentityProviderFacebook extends CustomResource

Manages an API Management Facebook Identity Provider.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@mycompany.io",
    skuName: "Developer_1",
});
const exampleIdentityProviderFacebook = new azure.apimanagement.IdentityProviderFacebook("exampleIdentityProviderFacebook", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    appId: "00000000000000000000000000000000",
    appSecret: "00000000000000000000000000000000",
});

constructor

new IdentityProviderFacebook(name: string, args: IdentityProviderFacebookArgs, opts?: pulumi.CustomResourceOptions)

Create a IdentityProviderFacebook resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IdentityProviderFacebookState, opts?: pulumi.CustomResourceOptions): IdentityProviderFacebook

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IdentityProviderFacebook

Returns true if the given object is an instance of IdentityProviderFacebook. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property appId

public appId: pulumi.Output<string>;

App ID for Facebook.

property appSecret

public appSecret: pulumi.Output<string>;

App Secret for Facebook.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource IdentityProviderGoogle

class IdentityProviderGoogle extends CustomResource

Manages an API Management Google Identity Provider.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@mycompany.io",
    skuName: "Developer_1",
});
const exampleIdentityProviderGoogle = new azure.apimanagement.IdentityProviderGoogle("exampleIdentityProviderGoogle", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    clientId: "00000000.apps.googleusercontent.com",
    clientSecret: "00000000000000000000000000000000",
});

constructor

new IdentityProviderGoogle(name: string, args: IdentityProviderGoogleArgs, opts?: pulumi.CustomResourceOptions)

Create a IdentityProviderGoogle resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IdentityProviderGoogleState, opts?: pulumi.CustomResourceOptions): IdentityProviderGoogle

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IdentityProviderGoogle

Returns true if the given object is an instance of IdentityProviderGoogle. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property clientId

public clientId: pulumi.Output<string>;

Client Id for Google Sign-in.

property clientSecret

public clientSecret: pulumi.Output<string>;

Client secret for Google Sign-in.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource IdentityProviderMicrosoft

class IdentityProviderMicrosoft extends CustomResource

Manages an API Management Microsoft Identity Provider.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@mycompany.io",
    skuName: "Developer_1",
});
const exampleIdentityProviderMicrosoft = new azure.apimanagement.IdentityProviderMicrosoft("exampleIdentityProviderMicrosoft", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    clientId: "00000000-0000-0000-0000-000000000000",
    clientSecret: "00000000000000000000000000000000",
});

constructor

new IdentityProviderMicrosoft(name: string, args: IdentityProviderMicrosoftArgs, opts?: pulumi.CustomResourceOptions)

Create a IdentityProviderMicrosoft resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IdentityProviderMicrosoftState, opts?: pulumi.CustomResourceOptions): IdentityProviderMicrosoft

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IdentityProviderMicrosoft

Returns true if the given object is an instance of IdentityProviderMicrosoft. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property clientId

public clientId: pulumi.Output<string>;

Client Id of the Azure AD Application.

property clientSecret

public clientSecret: pulumi.Output<string>;

Client secret of the Azure AD Application.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource IdentityProviderTwitter

class IdentityProviderTwitter extends CustomResource

Manages an API Management Twitter Identity Provider.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@mycompany.io",
    skuName: "Developer_1",
});
const exampleIdentityProviderTwitter = new azure.apimanagement.IdentityProviderTwitter("exampleIdentityProviderTwitter", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    apiKey: "00000000000000000000000000000000",
    apiSecretKey: "00000000000000000000000000000000",
});

constructor

new IdentityProviderTwitter(name: string, args: IdentityProviderTwitterArgs, opts?: pulumi.CustomResourceOptions)

Create a IdentityProviderTwitter resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IdentityProviderTwitterState, opts?: pulumi.CustomResourceOptions): IdentityProviderTwitter

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IdentityProviderTwitter

Returns true if the given object is an instance of IdentityProviderTwitter. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiKey

public apiKey: pulumi.Output<string>;

App Consumer API key for Twitter.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property apiSecretKey

public apiSecretKey: pulumi.Output<string>;

App Consumer API secret key for Twitter.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Logger

class Logger extends CustomResource

Manages a Logger within an API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleInsights = new azure.appinsights.Insights("exampleInsights", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    applicationType: "other",
});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
const exampleLogger = new azure.apimanagement.Logger("exampleLogger", {
    apiManagementName: exampleService.name,
    resourceGroupName: exampleResourceGroup.name,
    application_insights: {
        instrumentationKey: exampleInsights.instrumentationKey,
    },
});

constructor

new Logger(name: string, args: LoggerArgs, opts?: pulumi.CustomResourceOptions)

Create a Logger resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LoggerState, opts?: pulumi.CustomResourceOptions): Logger

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Logger

Returns true if the given object is an instance of Logger. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property applicationInsights

public applicationInsights: pulumi.Output<LoggerApplicationInsights | undefined>;

An applicationInsights block as documented below.

property buffered

public buffered: pulumi.Output<boolean | undefined>;

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

property description

public description: pulumi.Output<string | undefined>;

A description of this Logger.

property eventhub

public eventhub: pulumi.Output<LoggerEventhub | undefined>;

An eventhub block as documented below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NamedValue

class NamedValue extends CustomResource

Manages an API Management Named Value.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Developer_1",
});
const exampleNamedValue = new azure.apimanagement.NamedValue("exampleNamedValue", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    displayName: "ExampleProperty",
    value: "Example Value",
});

constructor

new NamedValue(name: string, args: NamedValueArgs, opts?: pulumi.CustomResourceOptions)

Create a NamedValue resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NamedValueState, opts?: pulumi.CustomResourceOptions): NamedValue

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NamedValue

Returns true if the given object is an instance of NamedValue. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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.

property displayName

public displayName: pulumi.Output<string>;

The display name of this API Management Named Value.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secret

public secret: pulumi.Output<boolean | undefined>;

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

property tags

public tags: pulumi.Output<string[] | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The value of this API Management Named Value.

Resource OpenIdConnectProvider

class OpenIdConnectProvider extends CustomResource

Manages an OpenID Connect Provider within a API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
const exampleOpenIdConnectProvider = new azure.apimanagement.OpenIdConnectProvider("exampleOpenIdConnectProvider", {
    apiManagementName: exampleService.name,
    resourceGroupName: exampleResourceGroup.name,
    clientId: "00001111-2222-3333-4444-555566667777",
    displayName: "Example Provider",
    metadataEndpoint: "https://example.com/example",
});

constructor

new OpenIdConnectProvider(name: string, args: OpenIdConnectProviderArgs, opts?: pulumi.CustomResourceOptions)

Create a OpenIdConnectProvider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OpenIdConnectProviderState, opts?: pulumi.CustomResourceOptions): OpenIdConnectProvider

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is OpenIdConnectProvider

Returns true if the given object is an instance of OpenIdConnectProvider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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.

property clientId

public clientId: pulumi.Output<string>;

The Client ID used for the Client Application.

property clientSecret

public clientSecret: pulumi.Output<string>;

The Client Secret used for the Client Application.

property description

public description: pulumi.Output<string | undefined>;

A description of this OpenID Connect Provider.

property displayName

public displayName: pulumi.Output<string>;

A user-friendly name for this OpenID Connect Provider.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property metadataEndpoint

public metadataEndpoint: pulumi.Output<string>;

The URI of the Metadata endpoint.

property name

public name: pulumi.Output<string>;

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.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Product

class Product extends CustomResource

Manages an API Management Product.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
const exampleProduct = new azure.apimanagement.Product("exampleProduct", {
    productId: "test-product",
    apiManagementName: exampleService.name,
    resourceGroupName: exampleResourceGroup.name,
    displayName: "Test Product",
    subscriptionRequired: true,
    approvalRequired: true,
    published: true,
});

constructor

new Product(name: string, args: ProductArgs, opts?: pulumi.CustomResourceOptions)

Create a Product resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProductState, opts?: pulumi.CustomResourceOptions): Product

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Product

Returns true if the given object is an instance of Product. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property approvalRequired

public approvalRequired: pulumi.Output<boolean | undefined>;

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

property description

public description: pulumi.Output<string | undefined>;

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

property displayName

public displayName: pulumi.Output<string>;

The Display Name for this API Management Product.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property productId

public productId: pulumi.Output<string>;

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

property published

public published: pulumi.Output<boolean>;

Is this Product Published?

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property subscriptionRequired

public subscriptionRequired: pulumi.Output<boolean>;

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

property subscriptionsLimit

public subscriptionsLimit: pulumi.Output<number | undefined>;

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

property terms

public terms: pulumi.Output<string | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProductApi

class ProductApi extends CustomResource

Manages an API Management API Assignment to a Product.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleService = azure.apimanagement.getService({
    name: "example-api",
    resourceGroupName: "example-resources",
});
const exampleApi = Promise.all([exampleService, exampleService]).then(([exampleService, exampleService1]) => azure.apimanagement.getApi({
    name: "search-api",
    apiManagementName: exampleService.name,
    resourceGroupName: exampleService1.resourceGroupName,
    revision: "2",
}));
const exampleProduct = Promise.all([exampleService, exampleService]).then(([exampleService, exampleService1]) => azure.apimanagement.getProduct({
    productId: "my-product",
    apiManagementName: exampleService.name,
    resourceGroupName: exampleService1.resourceGroupName,
}));
const exampleProductApi = new azure.apimanagement.ProductApi("exampleProductApi", {
    apiName: exampleApi.then(exampleApi => exampleApi.name),
    productId: exampleProduct.then(exampleProduct => exampleProduct.productId),
    apiManagementName: exampleService.then(exampleService => exampleService.name),
    resourceGroupName: exampleService.then(exampleService => exampleService.resourceGroupName),
});

constructor

new ProductApi(name: string, args: ProductApiArgs, opts?: pulumi.CustomResourceOptions)

Create a ProductApi resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProductApiState, opts?: pulumi.CustomResourceOptions): ProductApi

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProductApi

Returns true if the given object is an instance of ProductApi. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property apiName

public apiName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property productId

public productId: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProductGroup

class ProductGroup extends CustomResource

Manages an API Management Product Assignment to a Group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleService = azure.apimanagement.getService({
    name: "example-api",
    resourceGroupName: "example-resources",
});
const exampleProduct = Promise.all([exampleService, exampleService]).then(([exampleService, exampleService1]) => azure.apimanagement.getProduct({
    productId: "my-product",
    apiManagementName: exampleService.name,
    resourceGroupName: exampleService1.resourceGroupName,
}));
const exampleGroup = Promise.all([exampleService, exampleService]).then(([exampleService, exampleService1]) => azure.apimanagement.getGroup({
    name: "my-group",
    apiManagementName: exampleService.name,
    resourceGroupName: exampleService1.resourceGroupName,
}));
const exampleProductGroup = new azure.apimanagement.ProductGroup("exampleProductGroup", {
    productId: exampleProduct.then(exampleProduct => exampleProduct.productId),
    groupName: exampleGroup.then(exampleGroup => exampleGroup.name),
    apiManagementName: exampleService.then(exampleService => exampleService.name),
    resourceGroupName: exampleService.then(exampleService => exampleService.resourceGroupName),
});

constructor

new ProductGroup(name: string, args: ProductGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ProductGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProductGroupState, opts?: pulumi.CustomResourceOptions): ProductGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProductGroup

Returns true if the given object is an instance of ProductGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property groupName

public groupName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property productId

public productId: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProductPolicy

class ProductPolicy extends CustomResource

Manages an API Management Product Policy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleProduct = azure.apimanagement.getProduct({
    productId: "my-product",
    apiManagementName: "example-apim",
    resourceGroupName: "search-service",
});
const exampleProductPolicy = new azure.apimanagement.ProductPolicy("exampleProductPolicy", {
    productId: exampleProduct.then(exampleProduct => exampleProduct.productId),
    apiManagementName: exampleProduct.then(exampleProduct => exampleProduct.apiManagementName),
    resourceGroupName: exampleProduct.then(exampleProduct => exampleProduct.resourceGroupName),
    xmlContent: `<policies>
  <inbound>
    <find-and-replace from="xyz" to="abc" />
  </inbound>
</policies>
`,
});

constructor

new ProductPolicy(name: string, args: ProductPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a ProductPolicy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProductPolicyState, opts?: pulumi.CustomResourceOptions): ProductPolicy

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProductPolicy

Returns true if the given object is an instance of ProductPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property productId

public productId: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property xmlContent

public xmlContent: pulumi.Output<string>;

The XML Content for this Policy.

public xmlLink: pulumi.Output<string | undefined>;

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

Resource Property

class Property extends CustomResource

Manages an API Management Property.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Developer_1",
});
const exampleProperty = new azure.apimanagement.Property("exampleProperty", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    displayName: "ExampleProperty",
    value: "Example Value",
});

constructor

new Property(name: string, args: PropertyArgs, opts?: pulumi.CustomResourceOptions)

Create a Property resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PropertyState, opts?: pulumi.CustomResourceOptions): Property

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Property

Returns true if the given object is an instance of Property. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property displayName

public displayName: pulumi.Output<string>;

The display name of this API Management Property.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secret

public secret: pulumi.Output<boolean | undefined>;

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

property tags

public tags: pulumi.Output<string[] | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The value of this API Management Property.

Resource Service

class Service extends CustomResource

Manages an API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
    policy: {
        xmlContent: `    <policies>
      <inbound />
      <backend />
      <outbound />
      <on-error />
    </policies>
`,
    },
});

constructor

new Service(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property additionalLocations

public additionalLocations: pulumi.Output<ServiceAdditionalLocation[] | undefined>;

One or more additionalLocation blocks as defined below.

property certificates

public certificates: pulumi.Output<ServiceCertificate[] | undefined>;

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

property gatewayRegionalUrl

public gatewayRegionalUrl: pulumi.Output<string>;

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

property gatewayUrl

public gatewayUrl: pulumi.Output<string>;

The URL of the Gateway for the API Management Service.

property hostnameConfiguration

public hostnameConfiguration: pulumi.Output<ServiceHostnameConfiguration>;

A hostnameConfiguration block as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<ServiceIdentity | undefined>;

An identity block is documented below.

property location

public location: pulumi.Output<string>;

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

property managementApiUrl

public managementApiUrl: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property notificationSenderEmail

public notificationSenderEmail: pulumi.Output<string>;

Email address from which the notification will be sent.

property policy

public policy: pulumi.Output<ServicePolicy>;

A policy block as defined below.

property portalUrl

public portalUrl: pulumi.Output<string>;

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

property privateIpAddresses

public privateIpAddresses: pulumi.Output<string[]>;

property protocols

public protocols: pulumi.Output<ServiceProtocols>;

A protocols block as defined below.

property publicIpAddresses

public publicIpAddresses: pulumi.Output<string[]>;

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

property publisherEmail

public publisherEmail: pulumi.Output<string>;

The email of publisher/company.

property publisherName

public publisherName: pulumi.Output<string>;

The name of publisher/company.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property scmUrl

public scmUrl: pulumi.Output<string>;

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

property security

public security: pulumi.Output<ServiceSecurity>;

A security block as defined below.

property signIn

public signIn: pulumi.Output<ServiceSignIn>;

A signIn block as defined below.

property signUp

public signUp: pulumi.Output<ServiceSignUp>;

A signUp block as defined below.

property skuName

public skuName: pulumi.Output<string>;

skuName 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).

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags assigned to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualNetworkConfiguration

public virtualNetworkConfiguration: pulumi.Output<ServiceVirtualNetworkConfiguration | undefined>;

A virtualNetworkConfiguration block as defined below. Required when virtualNetworkType is External or Internal.

property virtualNetworkType

public virtualNetworkType: pulumi.Output<string | undefined>;

The type of virtual network you want to use, valid values include: None, External, Internal.

Resource Subscription

class Subscription extends CustomResource

Manages a Subscription within a API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleService = azure.apimanagement.getService({
    name: "example-apim",
    resourceGroupName: "example-resources",
});
const exampleProduct = Promise.all([exampleService, exampleService]).then(([exampleService, exampleService1]) => azure.apimanagement.getProduct({
    productId: "00000000-0000-0000-0000-000000000000",
    apiManagementName: exampleService.name,
    resourceGroupName: exampleService1.resourceGroupName,
}));
const exampleUser = Promise.all([exampleService, exampleService]).then(([exampleService, exampleService1]) => azure.apimanagement.getUser({
    userId: "11111111-1111-1111-1111-111111111111",
    apiManagementName: exampleService.name,
    resourceGroupName: exampleService1.resourceGroupName,
}));
const exampleSubscription = new azure.apimanagement.Subscription("exampleSubscription", {
    apiManagementName: exampleService.then(exampleService => exampleService.name),
    resourceGroupName: exampleService.then(exampleService => exampleService.resourceGroupName),
    userId: exampleUser.then(exampleUser => exampleUser.id),
    productId: exampleProduct.then(exampleProduct => exampleProduct.id),
    displayName: "Parser API",
});

constructor

new Subscription(name: string, args: SubscriptionArgs, opts?: pulumi.CustomResourceOptions)

Create a Subscription resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubscriptionState, opts?: pulumi.CustomResourceOptions): Subscription

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Subscription

Returns true if the given object is an instance of Subscription. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property displayName

public displayName: pulumi.Output<string>;

The display name of this Subscription.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property primaryKey

public primaryKey: pulumi.Output<string>;

property productId

public productId: pulumi.Output<string | undefined>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secondaryKey

public secondaryKey: pulumi.Output<string>;

property state

public state: pulumi.Output<string | undefined>;

The state of this Subscription. Possible values are active, cancelled, expired, rejected, submitted and suspended. Defaults to submitted.

property subscriptionId

public subscriptionId: pulumi.Output<string>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string>;

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

Resource User

class User extends CustomResource

Manages an API Management User.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
const exampleUser = new azure.apimanagement.User("exampleUser", {
    userId: "5931a75ae4bbd512288c680b",
    apiManagementName: exampleService.name,
    resourceGroupName: exampleResourceGroup.name,
    firstName: "Example",
    lastName: "User",
    email: "user@example.com",
    state: "active",
});

constructor

new User(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions)

Create a User resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is User

Returns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiManagementName

public apiManagementName: pulumi.Output<string>;

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

property confirmation

public confirmation: pulumi.Output<string | undefined>;

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.

property email

public email: pulumi.Output<string>;

The email address associated with this user.

property firstName

public firstName: pulumi.Output<string>;

The first name for this user.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lastName

public lastName: pulumi.Output<string>;

The last name for this user.

property note

public note: pulumi.Output<string | undefined>;

A note about this user.

property password

public password: pulumi.Output<string | undefined>;

The password associated with this user.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property state

public state: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string>;

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

Functions

Function getApi

getApi(args: GetApiArgs, opts?: pulumi.InvokeOptions): Promise<GetApiResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.apimanagement.getApi({
    name: "search-api",
    apiManagementName: "search-api-management",
    resourceGroupName: "search-service",
    revision: "2",
});
export const apiManagementApiId = example.then(example => example.id);

Function getApiVersionSet

getApiVersionSet(args: GetApiVersionSetArgs, opts?: pulumi.InvokeOptions): Promise<GetApiVersionSetResult>

Uses this data source to access information about an API Version Set within an API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.apimanagement.getApiVersionSet({
    resourceGroupName: "example-resources",
    apiManagementName: "example-api",
    name: "example-api-version-set",
});
export const apiManagementApiVersionSetId = example.then(example => example.id);

Function getGroup

getGroup(args: GetGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.apimanagement.getGroup({
    name: "my-group",
    apiManagementName: "example-apim",
    resourceGroupName: "search-service",
});
export const groupType = example.then(example => example.type);

Function getProduct

getProduct(args: GetProductArgs, opts?: pulumi.InvokeOptions): Promise<GetProductResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.apimanagement.getProduct({
    productId: "my-product",
    apiManagementName: "example-apim",
    resourceGroupName: "search-service",
});
export const productTerms = example.then(example => example.terms);

Function getService

getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.apimanagement.getService({
    name: "search-api",
    resourceGroupName: "search-service",
});
export const apiManagementId = example.then(example => example.id);

Function getUser

getUser(args: GetUserArgs, opts?: pulumi.InvokeOptions): Promise<GetUserResult>

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

Others

interface ApiArgs

interface ApiArgs

The set of arguments for constructing a Api resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

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

property displayName

displayName: pulumi.Input<string>;

The display name of the API.

property import

import?: pulumi.Input<ApiImport>;

A import block as documented below.

property name

name?: pulumi.Input<string>;

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

property path

path: pulumi.Input<string>;

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.

property protocols

protocols: pulumi.Input<pulumi.Input<string>[]>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property revision

revision: pulumi.Input<string>;

The Revision which used for this API.

property serviceUrl

serviceUrl?: pulumi.Input<string>;

Absolute URL of the backend service implementing this API.

property soapPassThrough

soapPassThrough?: pulumi.Input<boolean>;

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

property subscriptionKeyParameterNames

subscriptionKeyParameterNames?: pulumi.Input<ApiSubscriptionKeyParameterNames>;

A subscriptionKeyParameterNames block as documented below.

property version

version?: pulumi.Input<string>;

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

property versionSetId

versionSetId?: pulumi.Input<string>;

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

interface ApiOperationArgs

interface ApiOperationArgs

The set of arguments for constructing a ApiOperation resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property apiName

apiName: pulumi.Input<string>;

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.

property description

description?: pulumi.Input<string>;

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

property displayName

displayName: pulumi.Input<string>;

The Display Name for this API Management Operation.

property method

method: pulumi.Input<string>;

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

property operationId

operationId: pulumi.Input<string>;

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

property request

request?: pulumi.Input<ApiOperationRequest>;

A request block as defined below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property responses

responses?: pulumi.Input<pulumi.Input<ApiOperationResponse>[]>;

One or more response blocks as defined below.

property templateParameters

templateParameters?: pulumi.Input<pulumi.Input<ApiOperationTemplateParameter>[]>;

One or more templateParameter blocks as defined below.

property urlTemplate

urlTemplate: pulumi.Input<string>;

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

interface ApiOperationPolicyArgs

interface ApiOperationPolicyArgs

The set of arguments for constructing a ApiOperationPolicy resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property apiName

apiName: pulumi.Input<string>;

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

property operationId

operationId: pulumi.Input<string>;

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property xmlContent

xmlContent?: pulumi.Input<string>;

The XML Content for this Policy.

xmlLink?: pulumi.Input<string>;

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

interface ApiOperationPolicyState

interface ApiOperationPolicyState

Input properties used for looking up and filtering ApiOperationPolicy resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property apiName

apiName?: pulumi.Input<string>;

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

property operationId

operationId?: pulumi.Input<string>;

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property xmlContent

xmlContent?: pulumi.Input<string>;

The XML Content for this Policy.

xmlLink?: pulumi.Input<string>;

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

interface ApiOperationState

interface ApiOperationState

Input properties used for looking up and filtering ApiOperation resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property apiName

apiName?: pulumi.Input<string>;

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.

property description

description?: pulumi.Input<string>;

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

property displayName

displayName?: pulumi.Input<string>;

The Display Name for this API Management Operation.

property method

method?: pulumi.Input<string>;

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

property operationId

operationId?: pulumi.Input<string>;

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

property request

request?: pulumi.Input<ApiOperationRequest>;

A request block as defined below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property responses

responses?: pulumi.Input<pulumi.Input<ApiOperationResponse>[]>;

One or more response blocks as defined below.

property templateParameters

templateParameters?: pulumi.Input<pulumi.Input<ApiOperationTemplateParameter>[]>;

One or more templateParameter blocks as defined below.

property urlTemplate

urlTemplate?: pulumi.Input<string>;

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

interface ApiPolicyArgs

interface ApiPolicyArgs

The set of arguments for constructing a ApiPolicy resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property apiName

apiName: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property xmlContent

xmlContent?: pulumi.Input<string>;

The XML Content for this Policy as a string.

xmlLink?: pulumi.Input<string>;

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

interface ApiPolicyState

interface ApiPolicyState

Input properties used for looking up and filtering ApiPolicy resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property apiName

apiName?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property xmlContent

xmlContent?: pulumi.Input<string>;

The XML Content for this Policy as a string.

xmlLink?: pulumi.Input<string>;

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

interface ApiSchemaArgs

interface ApiSchemaArgs

The set of arguments for constructing a ApiSchema resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property apiName

apiName: pulumi.Input<string>;

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.

property contentType

contentType: pulumi.Input<string>;

The content type of the API Schema.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property schemaId

schemaId: pulumi.Input<string>;

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

property value

value: pulumi.Input<string>;

The JSON escaped string defining the document representing the Schema.

interface ApiSchemaState

interface ApiSchemaState

Input properties used for looking up and filtering ApiSchema resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property apiName

apiName?: pulumi.Input<string>;

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.

property contentType

contentType?: pulumi.Input<string>;

The content type of the API Schema.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property schemaId

schemaId?: pulumi.Input<string>;

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

property value

value?: pulumi.Input<string>;

The JSON escaped string defining the document representing the Schema.

interface ApiState

interface ApiState

Input properties used for looking up and filtering Api resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

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

property displayName

displayName?: pulumi.Input<string>;

The display name of the API.

property import

import?: pulumi.Input<ApiImport>;

A import block as documented below.

property isCurrent

isCurrent?: pulumi.Input<boolean>;

Is this the current API Revision?

property isOnline

isOnline?: pulumi.Input<boolean>;

Is this API Revision online/accessible via the Gateway?

property name

name?: pulumi.Input<string>;

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

property path

path?: pulumi.Input<string>;

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.

property protocols

protocols?: pulumi.Input<pulumi.Input<string>[]>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property revision

revision?: pulumi.Input<string>;

The Revision which used for this API.

property serviceUrl

serviceUrl?: pulumi.Input<string>;

Absolute URL of the backend service implementing this API.

property soapPassThrough

soapPassThrough?: pulumi.Input<boolean>;

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

property subscriptionKeyParameterNames

subscriptionKeyParameterNames?: pulumi.Input<ApiSubscriptionKeyParameterNames>;

A subscriptionKeyParameterNames block as documented below.

property version

version?: pulumi.Input<string>;

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

property versionSetId

versionSetId?: pulumi.Input<string>;

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

interface ApiVersionSetArgs

interface ApiVersionSetArgs

The set of arguments for constructing a ApiVersionSet resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of API Version Set.

property displayName

displayName: pulumi.Input<string>;

The display name of this API Version Set.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property versionHeaderName

versionHeaderName?: pulumi.Input<string>;

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

property versionQueryName

versionQueryName?: pulumi.Input<string>;

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

property versioningScheme

versioningScheme: pulumi.Input<string>;

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

interface ApiVersionSetState

interface ApiVersionSetState

Input properties used for looking up and filtering ApiVersionSet resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of API Version Set.

property displayName

displayName?: pulumi.Input<string>;

The display name of this API Version Set.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property versionHeaderName

versionHeaderName?: pulumi.Input<string>;

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

property versionQueryName

versionQueryName?: pulumi.Input<string>;

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

property versioningScheme

versioningScheme?: pulumi.Input<string>;

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

interface AuthorizationServerArgs

interface AuthorizationServerArgs

The set of arguments for constructing a AuthorizationServer resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property authorizationEndpoint

authorizationEndpoint: pulumi.Input<string>;

The OAUTH Authorization Endpoint.

property authorizationMethods

authorizationMethods: pulumi.Input<pulumi.Input<string>[]>;

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

property bearerTokenSendingMethods

bearerTokenSendingMethods?: pulumi.Input<pulumi.Input<string>[]>;

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

property clientAuthenticationMethods

clientAuthenticationMethods?: pulumi.Input<pulumi.Input<string>[]>;

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

property clientId

clientId: pulumi.Input<string>;

The Client/App ID registered with this Authorization Server.

property clientRegistrationEndpoint

clientRegistrationEndpoint: pulumi.Input<string>;

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

property clientSecret

clientSecret?: pulumi.Input<string>;

The Client/App Secret registered with this Authorization Server.

property defaultScope

defaultScope?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

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

property displayName

displayName: pulumi.Input<string>;

The user-friendly name of this Authorization Server.

property grantTypes

grantTypes: pulumi.Input<pulumi.Input<string>[]>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property resourceOwnerPassword

resourceOwnerPassword?: pulumi.Input<string>;

The password associated with the Resource Owner.

property resourceOwnerUsername

resourceOwnerUsername?: pulumi.Input<string>;

The username associated with the Resource Owner.

property supportState

supportState?: pulumi.Input<boolean>;

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

property tokenBodyParameters

tokenBodyParameters?: pulumi.Input<pulumi.Input<AuthorizationServerTokenBodyParameter>[]>;

property tokenEndpoint

tokenEndpoint?: pulumi.Input<string>;

The OAUTH Token Endpoint.

interface AuthorizationServerState

interface AuthorizationServerState

Input properties used for looking up and filtering AuthorizationServer resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property authorizationEndpoint

authorizationEndpoint?: pulumi.Input<string>;

The OAUTH Authorization Endpoint.

property authorizationMethods

authorizationMethods?: pulumi.Input<pulumi.Input<string>[]>;

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

property bearerTokenSendingMethods

bearerTokenSendingMethods?: pulumi.Input<pulumi.Input<string>[]>;

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

property clientAuthenticationMethods

clientAuthenticationMethods?: pulumi.Input<pulumi.Input<string>[]>;

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

property clientId

clientId?: pulumi.Input<string>;

The Client/App ID registered with this Authorization Server.

property clientRegistrationEndpoint

clientRegistrationEndpoint?: pulumi.Input<string>;

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

property clientSecret

clientSecret?: pulumi.Input<string>;

The Client/App Secret registered with this Authorization Server.

property defaultScope

defaultScope?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

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

property displayName

displayName?: pulumi.Input<string>;

The user-friendly name of this Authorization Server.

property grantTypes

grantTypes?: pulumi.Input<pulumi.Input<string>[]>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property resourceOwnerPassword

resourceOwnerPassword?: pulumi.Input<string>;

The password associated with the Resource Owner.

property resourceOwnerUsername

resourceOwnerUsername?: pulumi.Input<string>;

The username associated with the Resource Owner.

property supportState

supportState?: pulumi.Input<boolean>;

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

property tokenBodyParameters

tokenBodyParameters?: pulumi.Input<pulumi.Input<AuthorizationServerTokenBodyParameter>[]>;

property tokenEndpoint

tokenEndpoint?: pulumi.Input<string>;

The OAUTH Token Endpoint.

interface BackendArgs

interface BackendArgs

The set of arguments for constructing a Backend resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property credentials

credentials?: pulumi.Input<BackendCredentials>;

A credentials block as documented below.

property description

description?: pulumi.Input<string>;

The description of the backend.

property name

name?: pulumi.Input<string>;

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

property protocol

protocol: pulumi.Input<string>;

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

property proxy

proxy?: pulumi.Input<BackendProxy>;

A proxy block as documented below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property resourceId

resourceId?: pulumi.Input<string>;

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.

property serviceFabricCluster

serviceFabricCluster?: pulumi.Input<BackendServiceFabricCluster>;

A serviceFabricCluster block as documented below.

property title

title?: pulumi.Input<string>;

The title of the backend.

property tls

tls?: pulumi.Input<BackendTls>;

A tls block as documented below.

property url

url: pulumi.Input<string>;

The URL of the backend host.

interface BackendState

interface BackendState

Input properties used for looking up and filtering Backend resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property credentials

credentials?: pulumi.Input<BackendCredentials>;

A credentials block as documented below.

property description

description?: pulumi.Input<string>;

The description of the backend.

property name

name?: pulumi.Input<string>;

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

property protocol

protocol?: pulumi.Input<string>;

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

property proxy

proxy?: pulumi.Input<BackendProxy>;

A proxy block as documented below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property resourceId

resourceId?: pulumi.Input<string>;

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.

property serviceFabricCluster

serviceFabricCluster?: pulumi.Input<BackendServiceFabricCluster>;

A serviceFabricCluster block as documented below.

property title

title?: pulumi.Input<string>;

The title of the backend.

property tls

tls?: pulumi.Input<BackendTls>;

A tls block as documented below.

property url

url?: pulumi.Input<string>;

The URL of the backend host.

interface CertificateArgs

interface CertificateArgs

The set of arguments for constructing a Certificate resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property data

data: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property password

password?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface CertificateState

interface CertificateState

Input properties used for looking up and filtering Certificate resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property data

data?: pulumi.Input<string>;

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

property expiration

expiration?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property password

password?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property subject

subject?: pulumi.Input<string>;

The Subject of this Certificate.

property thumbprint

thumbprint?: pulumi.Input<string>;

The Thumbprint of this Certificate.

interface DiagnosticArgs

interface DiagnosticArgs

The set of arguments for constructing a Diagnostic resource.

property apiManagementLoggerId

apiManagementLoggerId: pulumi.Input<string>;

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

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property enabled

DEPRECATED this property has been removed from the API and will be removed in version 3.0 of the provider
enabled?: pulumi.Input<boolean>;

property identifier

identifier: pulumi.Input<string>;

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.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface DiagnosticState

interface DiagnosticState

Input properties used for looking up and filtering Diagnostic resources.

property apiManagementLoggerId

apiManagementLoggerId?: pulumi.Input<string>;

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

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property enabled

DEPRECATED this property has been removed from the API and will be removed in version 3.0 of the provider
enabled?: pulumi.Input<boolean>;

property identifier

identifier?: pulumi.Input<string>;

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.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface GetApiArgs

interface GetApiArgs

A collection of arguments for invoking getApi.

property apiManagementName

apiManagementName: string;

The name of the API Management Service in which the API Management API exists.

property name

name: string;

The name of the API Management API.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group in which the API Management Service exists.

property revision

revision: string;

The Revision of the API Management API.

interface GetApiResult

interface GetApiResult

A collection of values returned by getApi.

property apiManagementName

apiManagementName: string;

property description

description: string;

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

property displayName

displayName: string;

The display name of the API.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property isCurrent

isCurrent: boolean;

Is this the current API Revision?

property isOnline

isOnline: boolean;

Is this API Revision online/accessible via the Gateway?

property name

name: string;

property path

path: string;

The Path for this API Management API.

property protocols

protocols: string[];

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

property resourceGroupName

resourceGroupName: string;

property revision

revision: string;

property serviceUrl

serviceUrl: string;

Absolute URL of the backend service implementing this API.

property soapPassThrough

soapPassThrough: boolean;

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

property subscriptionKeyParameterNames

subscriptionKeyParameterNames: GetApiSubscriptionKeyParameterName[];

A subscriptionKeyParameterNames block as documented below.

property version

version: string;

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

property versionSetId

versionSetId: string;

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

interface GetApiVersionSetArgs

interface GetApiVersionSetArgs

A collection of arguments for invoking getApiVersionSet.

property apiManagementName

apiManagementName: string;

The name of the API Management Service where the API Version Set exists.

property name

name: string;

The name of the API Version Set.

property resourceGroupName

resourceGroupName: string;

The name of the Resource Group in which the parent API Management Service exists.

interface GetApiVersionSetResult

interface GetApiVersionSetResult

A collection of values returned by getApiVersionSet.

property apiManagementName

apiManagementName: string;

property description

description: string;

The description of API Version Set.

property displayName

displayName: string;

The display name of this API Version Set.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property versionHeaderName

versionHeaderName: string;

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

property versionQueryName

versionQueryName: string;

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

property versioningScheme

versioningScheme: string;

interface GetGroupArgs

interface GetGroupArgs

A collection of arguments for invoking getGroup.

property apiManagementName

apiManagementName: string;

The Name of the API Management Service in which this Group exists.

property name

name: string;

The Name of the API Management Group.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group in which the API Management Service exists.

interface GetGroupResult

interface GetGroupResult

A collection of values returned by getGroup.

property apiManagementName

apiManagementName: string;

property description

description: string;

The description of this API Management Group.

property displayName

displayName: string;

The display name of this API Management Group.

property externalId

externalId: string;

The identifier of the external Group.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property type

type: string;

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

interface GetProductArgs

interface GetProductArgs

A collection of arguments for invoking getProduct.

property apiManagementName

apiManagementName: string;

The Name of the API Management Service in which this Product exists.

property productId

productId: string;

The Identifier for the API Management Product.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group in which the API Management Service exists.

interface GetProductResult

interface GetProductResult

A collection of values returned by getProduct.

property apiManagementName

apiManagementName: string;

property approvalRequired

approvalRequired: boolean;

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

property description

description: string;

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

property displayName

displayName: string;

The Display Name for this API Management Product.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property productId

productId: string;

property published

published: boolean;

Is this Product Published?

property resourceGroupName

resourceGroupName: string;

property subscriptionRequired

subscriptionRequired: boolean;

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

property subscriptionsLimit

subscriptionsLimit: number;

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

property terms

terms: string;

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

interface GetServiceArgs

interface GetServiceArgs

A collection of arguments for invoking getService.

property name

name: string;

The name of the API Management service.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group in which the API Management Service exists.

interface GetServiceResult

interface GetServiceResult

A collection of values returned by getService.

property additionalLocations

additionalLocations: GetServiceAdditionalLocation[];

One or more additionalLocation blocks as defined below

property gatewayRegionalUrl

gatewayRegionalUrl: string;

Gateway URL of the API Management service in the Region.

property gatewayUrl

gatewayUrl: string;

The URL for the API Management Service’s Gateway.

property hostnameConfigurations

hostnameConfigurations: GetServiceHostnameConfiguration[];

A hostnameConfiguration block as defined below.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property identities

identities: GetServiceIdentity[];

(Optional) An identity block as defined below.

property location

location: string;

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

property managementApiUrl

managementApiUrl: string;

The URL for the Management API.

property name

name: string;

Specifies the plan’s pricing tier.

property notificationSenderEmail

notificationSenderEmail: string;

The email address from which the notification will be sent.

property portalUrl

portalUrl: string;

The URL of the Publisher Portal.

property publicIpAddresses

publicIpAddresses: string[];

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

property publisherEmail

publisherEmail: string;

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

property publisherName

publisherName: string;

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

property resourceGroupName

resourceGroupName: string;

property scmUrl

scmUrl: string;

The SCM (Source Code Management) endpoint.

property skuName

skuName: string;

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.

interface GetUserArgs

interface GetUserArgs

A collection of arguments for invoking getUser.

property apiManagementName

apiManagementName: string;

The Name of the API Management Service in which this User exists.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group in which the API Management Service exists.

property userId

userId: string;

The Identifier for the User.

interface GetUserResult

interface GetUserResult

A collection of values returned by getUser.

property apiManagementName

apiManagementName: string;

property email

email: string;

The Email Address used for this User.

property firstName

firstName: string;

The First Name for the User.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property lastName

lastName: string;

The Last Name for the User.

property note

note: string;

Any notes about this User.

property resourceGroupName

resourceGroupName: string;

property state

state: string;

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

property userId

userId: string;

interface GroupArgs

interface GroupArgs

The set of arguments for constructing a Group resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of this API Management Group.

property displayName

displayName: pulumi.Input<string>;

The display name of this API Management Group.

property externalId

externalId?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property type

type?: pulumi.Input<string>;

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

interface GroupState

interface GroupState

Input properties used for looking up and filtering Group resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of this API Management Group.

property displayName

displayName?: pulumi.Input<string>;

The display name of this API Management Group.

property externalId

externalId?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property type

type?: pulumi.Input<string>;

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

interface GroupUserArgs

interface GroupUserArgs

The set of arguments for constructing a GroupUser resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property groupName

groupName: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property userId

userId: pulumi.Input<string>;

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.

interface GroupUserState

interface GroupUserState

Input properties used for looking up and filtering GroupUser resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property groupName

groupName?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property userId

userId?: pulumi.Input<string>;

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.

interface IdentityProviderAadArgs

interface IdentityProviderAadArgs

The set of arguments for constructing a IdentityProviderAad resource.

property allowedTenants

allowedTenants: pulumi.Input<pulumi.Input<string>[]>;

List of allowed AAD Tenants.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property clientId

clientId: pulumi.Input<string>;

Client Id of the Application in the AAD Identity Provider.

property clientSecret

clientSecret: pulumi.Input<string>;

Client secret of the Application in the AAD Identity Provider.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface IdentityProviderAadState

interface IdentityProviderAadState

Input properties used for looking up and filtering IdentityProviderAad resources.

property allowedTenants

allowedTenants?: pulumi.Input<pulumi.Input<string>[]>;

List of allowed AAD Tenants.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property clientId

clientId?: pulumi.Input<string>;

Client Id of the Application in the AAD Identity Provider.

property clientSecret

clientSecret?: pulumi.Input<string>;

Client secret of the Application in the AAD Identity Provider.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface IdentityProviderFacebookArgs

interface IdentityProviderFacebookArgs

The set of arguments for constructing a IdentityProviderFacebook resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property appId

appId: pulumi.Input<string>;

App ID for Facebook.

property appSecret

appSecret: pulumi.Input<string>;

App Secret for Facebook.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface IdentityProviderFacebookState

interface IdentityProviderFacebookState

Input properties used for looking up and filtering IdentityProviderFacebook resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property appId

appId?: pulumi.Input<string>;

App ID for Facebook.

property appSecret

appSecret?: pulumi.Input<string>;

App Secret for Facebook.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface IdentityProviderGoogleArgs

interface IdentityProviderGoogleArgs

The set of arguments for constructing a IdentityProviderGoogle resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property clientId

clientId: pulumi.Input<string>;

Client Id for Google Sign-in.

property clientSecret

clientSecret: pulumi.Input<string>;

Client secret for Google Sign-in.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface IdentityProviderGoogleState

interface IdentityProviderGoogleState

Input properties used for looking up and filtering IdentityProviderGoogle resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property clientId

clientId?: pulumi.Input<string>;

Client Id for Google Sign-in.

property clientSecret

clientSecret?: pulumi.Input<string>;

Client secret for Google Sign-in.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface IdentityProviderMicrosoftArgs

interface IdentityProviderMicrosoftArgs

The set of arguments for constructing a IdentityProviderMicrosoft resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property clientId

clientId: pulumi.Input<string>;

Client Id of the Azure AD Application.

property clientSecret

clientSecret: pulumi.Input<string>;

Client secret of the Azure AD Application.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface IdentityProviderMicrosoftState

interface IdentityProviderMicrosoftState

Input properties used for looking up and filtering IdentityProviderMicrosoft resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property clientId

clientId?: pulumi.Input<string>;

Client Id of the Azure AD Application.

property clientSecret

clientSecret?: pulumi.Input<string>;

Client secret of the Azure AD Application.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface IdentityProviderTwitterArgs

interface IdentityProviderTwitterArgs

The set of arguments for constructing a IdentityProviderTwitter resource.

property apiKey

apiKey: pulumi.Input<string>;

App Consumer API key for Twitter.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property apiSecretKey

apiSecretKey: pulumi.Input<string>;

App Consumer API secret key for Twitter.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface IdentityProviderTwitterState

interface IdentityProviderTwitterState

Input properties used for looking up and filtering IdentityProviderTwitter resources.

property apiKey

apiKey?: pulumi.Input<string>;

App Consumer API key for Twitter.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property apiSecretKey

apiSecretKey?: pulumi.Input<string>;

App Consumer API secret key for Twitter.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface LoggerArgs

interface LoggerArgs

The set of arguments for constructing a Logger resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property applicationInsights

applicationInsights?: pulumi.Input<LoggerApplicationInsights>;

An applicationInsights block as documented below.

property buffered

buffered?: pulumi.Input<boolean>;

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

property description

description?: pulumi.Input<string>;

A description of this Logger.

property eventhub

eventhub?: pulumi.Input<LoggerEventhub>;

An eventhub block as documented below.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface LoggerState

interface LoggerState

Input properties used for looking up and filtering Logger resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property applicationInsights

applicationInsights?: pulumi.Input<LoggerApplicationInsights>;

An applicationInsights block as documented below.

property buffered

buffered?: pulumi.Input<boolean>;

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

property description

description?: pulumi.Input<string>;

A description of this Logger.

property eventhub

eventhub?: pulumi.Input<LoggerEventhub>;

An eventhub block as documented below.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface NamedValueArgs

interface NamedValueArgs

The set of arguments for constructing a NamedValue resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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.

property displayName

displayName: pulumi.Input<string>;

The display name of this API Management Named Value.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property secret

secret?: pulumi.Input<boolean>;

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

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

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

property value

value: pulumi.Input<string>;

The value of this API Management Named Value.

interface NamedValueState

interface NamedValueState

Input properties used for looking up and filtering NamedValue resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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.

property displayName

displayName?: pulumi.Input<string>;

The display name of this API Management Named Value.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secret

secret?: pulumi.Input<boolean>;

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

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

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

property value

value?: pulumi.Input<string>;

The value of this API Management Named Value.

interface OpenIdConnectProviderArgs

interface OpenIdConnectProviderArgs

The set of arguments for constructing a OpenIdConnectProvider resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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.

property clientId

clientId: pulumi.Input<string>;

The Client ID used for the Client Application.

property clientSecret

clientSecret: pulumi.Input<string>;

The Client Secret used for the Client Application.

property description

description?: pulumi.Input<string>;

A description of this OpenID Connect Provider.

property displayName

displayName: pulumi.Input<string>;

A user-friendly name for this OpenID Connect Provider.

property metadataEndpoint

metadataEndpoint: pulumi.Input<string>;

The URI of the Metadata endpoint.

property name

name?: pulumi.Input<string>;

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.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface OpenIdConnectProviderState

interface OpenIdConnectProviderState

Input properties used for looking up and filtering OpenIdConnectProvider resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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.

property clientId

clientId?: pulumi.Input<string>;

The Client ID used for the Client Application.

property clientSecret

clientSecret?: pulumi.Input<string>;

The Client Secret used for the Client Application.

property description

description?: pulumi.Input<string>;

A description of this OpenID Connect Provider.

property displayName

displayName?: pulumi.Input<string>;

A user-friendly name for this OpenID Connect Provider.

property metadataEndpoint

metadataEndpoint?: pulumi.Input<string>;

The URI of the Metadata endpoint.

property name

name?: pulumi.Input<string>;

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.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface ProductApiArgs

interface ProductApiArgs

The set of arguments for constructing a ProductApi resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property apiName

apiName: pulumi.Input<string>;

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

property productId

productId: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface ProductApiState

interface ProductApiState

Input properties used for looking up and filtering ProductApi resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property apiName

apiName?: pulumi.Input<string>;

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

property productId

productId?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface ProductArgs

interface ProductArgs

The set of arguments for constructing a Product resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property approvalRequired

approvalRequired?: pulumi.Input<boolean>;

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

property description

description?: pulumi.Input<string>;

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

property displayName

displayName: pulumi.Input<string>;

The Display Name for this API Management Product.

property productId

productId: pulumi.Input<string>;

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

property published

published: pulumi.Input<boolean>;

Is this Product Published?

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property subscriptionRequired

subscriptionRequired: pulumi.Input<boolean>;

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

property subscriptionsLimit

subscriptionsLimit?: pulumi.Input<number>;

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

property terms

terms?: pulumi.Input<string>;

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

interface ProductGroupArgs

interface ProductGroupArgs

The set of arguments for constructing a ProductGroup resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property groupName

groupName: pulumi.Input<string>;

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

property productId

productId: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface ProductGroupState

interface ProductGroupState

Input properties used for looking up and filtering ProductGroup resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property groupName

groupName?: pulumi.Input<string>;

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

property productId

productId?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface ProductPolicyArgs

interface ProductPolicyArgs

The set of arguments for constructing a ProductPolicy resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property productId

productId: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property xmlContent

xmlContent?: pulumi.Input<string>;

The XML Content for this Policy.

xmlLink?: pulumi.Input<string>;

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

interface ProductPolicyState

interface ProductPolicyState

Input properties used for looking up and filtering ProductPolicy resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property productId

productId?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property xmlContent

xmlContent?: pulumi.Input<string>;

The XML Content for this Policy.

xmlLink?: pulumi.Input<string>;

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

interface ProductState

interface ProductState

Input properties used for looking up and filtering Product resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property approvalRequired

approvalRequired?: pulumi.Input<boolean>;

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

property description

description?: pulumi.Input<string>;

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

property displayName

displayName?: pulumi.Input<string>;

The Display Name for this API Management Product.

property productId

productId?: pulumi.Input<string>;

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

property published

published?: pulumi.Input<boolean>;

Is this Product Published?

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property subscriptionRequired

subscriptionRequired?: pulumi.Input<boolean>;

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

property subscriptionsLimit

subscriptionsLimit?: pulumi.Input<number>;

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

property terms

terms?: pulumi.Input<string>;

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

interface PropertyArgs

interface PropertyArgs

The set of arguments for constructing a Property resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property displayName

displayName: pulumi.Input<string>;

The display name of this API Management Property.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property secret

secret?: pulumi.Input<boolean>;

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

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

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

property value

value: pulumi.Input<string>;

The value of this API Management Property.

interface PropertyState

interface PropertyState

Input properties used for looking up and filtering Property resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property displayName

displayName?: pulumi.Input<string>;

The display name of this API Management Property.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secret

secret?: pulumi.Input<boolean>;

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

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

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

property value

value?: pulumi.Input<string>;

The value of this API Management Property.

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property additionalLocations

additionalLocations?: pulumi.Input<pulumi.Input<ServiceAdditionalLocation>[]>;

One or more additionalLocation blocks as defined below.

property certificates

certificates?: pulumi.Input<pulumi.Input<ServiceCertificate>[]>;

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

property hostnameConfiguration

hostnameConfiguration?: pulumi.Input<ServiceHostnameConfiguration>;

A hostnameConfiguration block as defined below.

property identity

identity?: pulumi.Input<ServiceIdentity>;

An identity block is documented below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property notificationSenderEmail

notificationSenderEmail?: pulumi.Input<string>;

Email address from which the notification will be sent.

property policy

policy?: pulumi.Input<ServicePolicy>;

A policy block as defined below.

property protocols

protocols?: pulumi.Input<ServiceProtocols>;

A protocols block as defined below.

property publisherEmail

publisherEmail: pulumi.Input<string>;

The email of publisher/company.

property publisherName

publisherName: pulumi.Input<string>;

The name of publisher/company.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property security

security?: pulumi.Input<ServiceSecurity>;

A security block as defined below.

property signIn

signIn?: pulumi.Input<ServiceSignIn>;

A signIn block as defined below.

property signUp

signUp?: pulumi.Input<ServiceSignUp>;

A signUp block as defined below.

property skuName

skuName: pulumi.Input<string>;

skuName 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).

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags assigned to the resource.

property virtualNetworkConfiguration

virtualNetworkConfiguration?: pulumi.Input<ServiceVirtualNetworkConfiguration>;

A virtualNetworkConfiguration block as defined below. Required when virtualNetworkType is External or Internal.

property virtualNetworkType

virtualNetworkType?: pulumi.Input<string>;

The type of virtual network you want to use, valid values include: None, External, Internal.

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property additionalLocations

additionalLocations?: pulumi.Input<pulumi.Input<ServiceAdditionalLocation>[]>;

One or more additionalLocation blocks as defined below.

property certificates

certificates?: pulumi.Input<pulumi.Input<ServiceCertificate>[]>;

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

property gatewayRegionalUrl

gatewayRegionalUrl?: pulumi.Input<string>;

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

property gatewayUrl

gatewayUrl?: pulumi.Input<string>;

The URL of the Gateway for the API Management Service.

property hostnameConfiguration

hostnameConfiguration?: pulumi.Input<ServiceHostnameConfiguration>;

A hostnameConfiguration block as defined below.

property identity

identity?: pulumi.Input<ServiceIdentity>;

An identity block is documented below.

property location

location?: pulumi.Input<string>;

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

property managementApiUrl

managementApiUrl?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property notificationSenderEmail

notificationSenderEmail?: pulumi.Input<string>;

Email address from which the notification will be sent.

property policy

policy?: pulumi.Input<ServicePolicy>;

A policy block as defined below.

property portalUrl

portalUrl?: pulumi.Input<string>;

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

property privateIpAddresses

privateIpAddresses?: pulumi.Input<pulumi.Input<string>[]>;

property protocols

protocols?: pulumi.Input<ServiceProtocols>;

A protocols block as defined below.

property publicIpAddresses

publicIpAddresses?: pulumi.Input<pulumi.Input<string>[]>;

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

property publisherEmail

publisherEmail?: pulumi.Input<string>;

The email of publisher/company.

property publisherName

publisherName?: pulumi.Input<string>;

The name of publisher/company.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property scmUrl

scmUrl?: pulumi.Input<string>;

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

property security

security?: pulumi.Input<ServiceSecurity>;

A security block as defined below.

property signIn

signIn?: pulumi.Input<ServiceSignIn>;

A signIn block as defined below.

property signUp

signUp?: pulumi.Input<ServiceSignUp>;

A signUp block as defined below.

property skuName

skuName?: pulumi.Input<string>;

skuName 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).

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags assigned to the resource.

property virtualNetworkConfiguration

virtualNetworkConfiguration?: pulumi.Input<ServiceVirtualNetworkConfiguration>;

A virtualNetworkConfiguration block as defined below. Required when virtualNetworkType is External or Internal.

property virtualNetworkType

virtualNetworkType?: pulumi.Input<string>;

The type of virtual network you want to use, valid values include: None, External, Internal.

interface SubscriptionArgs

interface SubscriptionArgs

The set of arguments for constructing a Subscription resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property displayName

displayName: pulumi.Input<string>;

The display name of this Subscription.

property primaryKey

primaryKey?: pulumi.Input<string>;

property productId

productId?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property secondaryKey

secondaryKey?: pulumi.Input<string>;

property state

state?: pulumi.Input<string>;

The state of this Subscription. Possible values are active, cancelled, expired, rejected, submitted and suspended. Defaults to submitted.

property subscriptionId

subscriptionId?: pulumi.Input<string>;

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.

property userId

userId: pulumi.Input<string>;

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

interface SubscriptionState

interface SubscriptionState

Input properties used for looking up and filtering Subscription resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property displayName

displayName?: pulumi.Input<string>;

The display name of this Subscription.

property primaryKey

primaryKey?: pulumi.Input<string>;

property productId

productId?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secondaryKey

secondaryKey?: pulumi.Input<string>;

property state

state?: pulumi.Input<string>;

The state of this Subscription. Possible values are active, cancelled, expired, rejected, submitted and suspended. Defaults to submitted.

property subscriptionId

subscriptionId?: pulumi.Input<string>;

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.

property userId

userId?: pulumi.Input<string>;

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

interface UserArgs

interface UserArgs

The set of arguments for constructing a User resource.

property apiManagementName

apiManagementName: pulumi.Input<string>;

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

property confirmation

confirmation?: pulumi.Input<string>;

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.

property email

email: pulumi.Input<string>;

The email address associated with this user.

property firstName

firstName: pulumi.Input<string>;

The first name for this user.

property lastName

lastName: pulumi.Input<string>;

The last name for this user.

property note

note?: pulumi.Input<string>;

A note about this user.

property password

password?: pulumi.Input<string>;

The password associated with this user.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property state

state?: pulumi.Input<string>;

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

property userId

userId: pulumi.Input<string>;

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

interface UserState

interface UserState

Input properties used for looking up and filtering User resources.

property apiManagementName

apiManagementName?: pulumi.Input<string>;

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

property confirmation

confirmation?: pulumi.Input<string>;

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.

property email

email?: pulumi.Input<string>;

The email address associated with this user.

property firstName

firstName?: pulumi.Input<string>;

The first name for this user.

property lastName

lastName?: pulumi.Input<string>;

The last name for this user.

property note

note?: pulumi.Input<string>;

A note about this user.

property password

password?: pulumi.Input<string>;

The password associated with this user.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property state

state?: pulumi.Input<string>;

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

property userId

userId?: pulumi.Input<string>;

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