Module apimanagement

@pulumi/azure > apimanagement

Index ▾

apimanagement/api.ts apimanagement/apiOperation.ts apimanagement/apiVersionSet.ts apimanagement/authorizationServer.ts apimanagement/certificate.ts apimanagement/getApi.ts apimanagement/getGroup.ts apimanagement/getProduct.ts apimanagement/getService.ts apimanagement/getUser.ts apimanagement/group.ts apimanagement/groupUser.ts apimanagement/logger.ts apimanagement/openIdConnectProvider.ts apimanagement/product.ts apimanagement/productApi.ts apimanagement/productGroup.ts apimanagement/property.ts apimanagement/service.ts apimanagement/subscription.ts apimanagement/user.ts

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 testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "West Europe",
    name: "example-resources",
});
const testService = new azure.apimanagement.Service("test", {
    location: testResourceGroup.location,
    name: "example-apim",
    publisherEmail: "company@terraform.io",
    publisherName: "My Company",
    resourceGroupName: testResourceGroup.name,
    sku: {
        capacity: 1,
        name: "Developer",
    },
});
const testApi = new azure.apimanagement.Api("test", {
    apiManagementName: testService.name,
    displayName: "Example API",
    import: {
        contentFormat: "swagger-link-json",
        contentValue: "http://conferenceapi.azurewebsites.net/?format=json",
    },
    name: "example-api",
    path: "example",
    protocols: ["https"],
    resourceGroupName: testResourceGroup.name,
    revision: "1",
});

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<{
    contentFormat: string;
    contentValue: string;
    wsdlSelector: undefined | {
        endpointName: string;
        serviceName: string;
    };
} | 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<{
    header: string;
    query: string;
}>;

A subscription_key_parameter_names 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.

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

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<{
    description: undefined | string;
    headers: {
        defaultValue: undefined | string;
        description: undefined | string;
        name: string;
        required: boolean;
        type: string;
        values: string[];
    }[];
    queryParameters: {
        defaultValue: undefined | string;
        description: undefined | string;
        name: string;
        required: boolean;
        type: string;
        values: string[];
    }[];
    representations: {
        contentType: string;
        formParameters: {
            defaultValue: undefined | string;
            description: undefined | string;
            name: string;
            required: boolean;
            type: string;
            values: string[];
        }[];
        sample: undefined | string;
        schemaId: undefined | string;
        typeName: undefined | string;
    }[];
}>;

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<{
    description: undefined | string;
    headers: {
        defaultValue: undefined | string;
        description: undefined | string;
        name: string;
        required: boolean;
        type: string;
        values: string[];
    }[];
    representations: {
        contentType: string;
        formParameters: {
            defaultValue: undefined | string;
            description: undefined | string;
            name: string;
            required: boolean;
            type: string;
            values: string[];
        }[];
        sample: undefined | string;
        schemaId: undefined | string;
        typeName: undefined | string;
    }[];
    statusCode: number;
}[] | undefined>;

One or more response blocks as defined below.

property templateParameters

public templateParameters: pulumi.Output<{
    defaultValue: undefined | string;
    description: undefined | string;
    name: string;
    required: boolean;
    type: string;
    values: string[];
}[] | undefined>;

One or more template_parameter 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.

class ApiVersionSet

extends CustomResource

Manages an API Version Set 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("example", {
    location: "West US",
    name: "example-resources",
});
const exampleService = new azure.apimanagement.Service("example", {
    location: exampleResourceGroup.location,
    name: "example-apim",
    publisherEmail: "pub1@email.com",
    publisherName: "pub1",
    resourceGroupName: exampleResourceGroup.name,
    sku: {
        capacity: 1,
        name: "Developer",
    },
});
const exampleApiManagementVersionSet = new azure.ApiManagementVersionSet("example", {
    apiManagementName: exampleService.name,
    displayName: "ExampleAPIVersionSet",
    name: "example-apimapi-1.0.0",
    resourceGroupName: exampleResourceGroup.name,
    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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

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 exampleAuthorizationServer = new azure.apimanagement.AuthorizationServer("example", {
    apiManagementName: azurerm_api_management_example.name.apply(name => name),
    authorizationEndpoint: "https://example.mydomain.com/client/authorize",
    clientId: "42424242-4242-4242-4242-424242424242",
    clientRegistrationEndpoint: "https://example.mydomain.com/client/register",
    displayName: "Test Server",
    grantTypes: ["authorizationCode"],
    name: "test-server",
    resourceGroupName: azurerm_api_management_example.resourceGroupName.apply(resourceGroupName => resourceGroupName),
});
const exampleApi = pulumi.output(azure.apimanagement.getApi({
    apiManagementName: "search-api-management",
    name: "search-api",
    resourceGroupName: "search-service",
    revision: "2",
}));

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<{
    name: string;
    value: string;
}[] | 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.

class Certificate

extends CustomResource

Manages an Certificate within an API Management Service.

Example Usage

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

const testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "West Europe",
    name: "example-resources",
});
const testService = new azure.apimanagement.Service("test", {
    location: testResourceGroup.location,
    name: "example-apim",
    publisherEmail: "company@terraform.io",
    publisherName: "My Company",
    resourceGroupName: testResourceGroup.name,
    sku: {
        capacity: 1,
        name: "Developer",
    },
});
const testCertificate = new azure.apimanagement.Certificate("test", {
    apiManagementName: testService.name,
    data: (() => {
        throw "tf2pulumi error: NYI: call to filebase64";
        return (() => { throw "NYI: call to filebase64"; })();
    })(),
    name: "example-cert",
    resourceGroupName: testResourceGroup.name,
});

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

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("example", {
    location: "West US",
    name: "example-resources",
});
const exampleService = new azure.apimanagement.Service("example", {
    location: exampleResourceGroup.location,
    name: "example-apim",
    publisherEmail: "pub1@email.com",
    publisherName: "pub1",
    resourceGroupName: exampleResourceGroup.name,
    sku: {
        capacity: 1,
        name: "Developer",
    },
});
const exampleGroup = new azure.apimanagement.Group("example", {
    apiManagementName: exampleService.name,
    description: "This is an example API management group.",
    displayName: "Example Group",
    name: "example-apimg",
    resourceGroupName: exampleResourceGroup.name,
});

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

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 = pulumi.output(azure.apimanagement.getUser({
    apiManagementName: "example-apim",
    resourceGroupName: "search-service",
    userId: "my-user",
}));
const exampleGroupUser = new azure.apimanagement.GroupUser("example", {
    apiManagementName: exampleUser.apply(exampleUser => exampleUser.apiManagementName),
    groupName: "example-group",
    resourceGroupName: exampleUser.apply(exampleUser => exampleUser.resourceGroupName),
    userId: exampleUser.apply(exampleUser => exampleUser.id),
});

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

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("example", {
    location: "West US",
    name: "example-resources",
});
const exampleService = new azure.apimanagement.Service("example", {
    location: exampleResourceGroup.location,
    name: "example-apim",
    publisherEmail: "company@terraform.io",
    publisherName: "My Company",
    resourceGroupName: exampleResourceGroup.name,
    sku: {
        capacity: 1,
        name: "Developer",
    },
});
const exampleInsights = new azure.appinsights.Insights("example", {
    applicationType: "Other",
    location: exampleResourceGroup.location,
    name: "example-appinsights",
    resourceGroupName: exampleResourceGroup.name,
});
const exampleLogger = new azure.apimanagement.Logger("example", {
    apiManagementName: exampleService.name,
    applicationInsights: {
        instrumentationKey: exampleInsights.instrumentationKey,
    },
    name: "example-logger",
    resourceGroupName: exampleResourceGroup.name,
});

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<{
    instrumentationKey: string;
} | undefined>;

An application_insights 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<{
    connectionString: string;
    name: string;
} | 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.

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 testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "West Europe",
    name: "example-resources",
});
const testService = new azure.apimanagement.Service("test", {
    location: testResourceGroup.location,
    name: "example-apim",
    publisherEmail: "company@terraform.io",
    publisherName: "My Company",
    resourceGroupName: testResourceGroup.name,
    sku: {
        capacity: 1,
        name: "Developer",
    },
});
const testOpenIdConnectProvider = new azure.apimanagement.OpenIdConnectProvider("test", {
    apiManagementName: testService.name,
    clientId: "00001111-2222-3333-4444-555566667777",
    displayName: "Example Provider",
    metadataEndpoint: "https://example.com/example",
    name: "example-provider",
    resourceGroupName: testResourceGroup.name,
});

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

class Product

extends CustomResource

Manages an API Management Product.

Example Usage

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

const testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "West Europe",
    name: "example-resources",
});
const testService = new azure.apimanagement.Service("test", {
    location: testResourceGroup.location,
    name: "example-apim",
    publisherEmail: "company@terraform.io",
    publisherName: "My Company",
    resourceGroupName: testResourceGroup.name,
    sku: {
        capacity: 1,
        name: "Developer",
    },
});
const testProduct = new azure.apimanagement.Product("test", {
    apiManagementName: testService.name,
    approvalRequired: true,
    displayName: "Test Product",
    productId: "test-product",
    published: true,
    resourceGroupName: testResourceGroup.name,
    subscriptionRequired: 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

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 = pulumi.output(azure.apimanagement.getService({
    name: "example-api",
    resourceGroupName: "example-resources",
}));
const exampleApi = pulumi.all([exampleService, exampleService]).apply(([exampleService, exampleService1]) => azure.apimanagement.getApi({
    apiManagementName: exampleService.name,
    name: "search-api",
    resourceGroupName: exampleService1.resourceGroupName,
    revision: "2",
}));
const exampleProductApi = new azure.apimanagement.ProductApi("example", {
    apiManagementName: exampleService.apply(exampleService => exampleService.name),
    apiName: exampleApi.apply(exampleApi => exampleApi.name),
    productId: azurerm_api_management_product_example.productId.apply(productId => productId),
    resourceGroupName: exampleService.apply(exampleService => exampleService.resourceGroupName),
});
const test = pulumi.all([exampleService, exampleService]).apply(([exampleService, exampleService1]) => azure.apimanagement.getProduct({
    apiManagementName: exampleService.name,
    productId: "my-product",
    resourceGroupName: exampleService1.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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

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 = pulumi.output(azure.apimanagement.getService({
    name: "example-api",
    resourceGroupName: "example-resources",
}));
const exampleGroup = pulumi.all([exampleService, exampleService]).apply(([exampleService, exampleService1]) => azure.apimanagement.getGroup({
    apiManagementName: exampleService.name,
    name: "my-group",
    resourceGroupName: exampleService1.resourceGroupName,
}));
const exampleProductGroup = new azure.apimanagement.ProductGroup("example", {
    apiManagementName: exampleService.apply(exampleService => exampleService.name),
    groupName: exampleGroup.apply(exampleGroup => exampleGroup.name),
    productId: azurerm_api_management_user_example.id.apply(id => id),
    resourceGroupName: exampleService.apply(exampleService => exampleService.resourceGroupName),
});
const exampleProduct = pulumi.all([exampleService, exampleService]).apply(([exampleService, exampleService1]) => azure.apimanagement.getProduct({
    apiManagementName: exampleService.name,
    productId: "my-product",
    resourceGroupName: exampleService1.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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

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("example", {
    location: "West US",
    name: "example-resources",
});
const exampleService = new azure.apimanagement.Service("example", {
    location: exampleResourceGroup.location,
    name: "example-apim",
    publisherEmail: "pub1@email.com",
    publisherName: "pub1",
    resourceGroupName: exampleResourceGroup.name,
    sku: {
        capacity: 1,
        name: "Developer",
    },
});
const exampleProperty = new azure.apimanagement.Property("example", {
    apiManagementName: exampleService.name,
    displayName: "ExampleProperty",
    name: "example-apimg",
    resourceGroupName: exampleResourceGroup.name,
    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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

class Service

extends CustomResource

Manages an API Management Service.

Example Usage

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

const testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "West Europe",
    name: "example-resources",
});
const testService = new azure.apimanagement.Service("test", {
    location: testResourceGroup.location,
    name: "example-apim",
    publisherEmail: "company@terraform.io",
    publisherName: "My Company",
    resourceGroupName: testResourceGroup.name,
    sku: {
        capacity: 1,
        name: "Developer",
    },
});

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

static isInstance(obj: any): boolean

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

property additionalLocation

public additionalLocation: pulumi.Output<{
    gatewayRegionalUrl: string;
    location: string;
    publicIpAddresses: string[];
} | undefined>;

One or more additional_location blocks as defined below.

property certificates

public certificates: pulumi.Output<{
    certificatePassword: string;
    encodedCertificate: string;
    storeName: string;
}[] | 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<{
    managements: {
        certificate: undefined | string;
        certificatePassword: undefined | string;
        hostName: string;
        keyVaultId: undefined | string;
        negotiateClientCertificate: undefined | false | true;
    }[];
    portals: {
        certificate: undefined | string;
        certificatePassword: undefined | string;
        hostName: string;
        keyVaultId: undefined | string;
        negotiateClientCertificate: undefined | false | true;
    }[];
    proxies: {
        certificate: undefined | string;
        certificatePassword: undefined | string;
        defaultSslBinding: boolean;
        hostName: string;
        keyVaultId: undefined | string;
        negotiateClientCertificate: undefined | false | true;
    }[];
    scms: {
        certificate: undefined | string;
        certificatePassword: undefined | string;
        hostName: string;
        keyVaultId: undefined | string;
        negotiateClientCertificate: undefined | false | true;
    }[];
}>;

A hostname_configuration 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<{
    principalId: string;
    tenantId: string;
    type: string;
} | 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<{
    xmlContent: string;
    xmlLink: undefined | string;
}>;

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 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<{
    disableBackendSsl30: undefined | false | true;
    disableBackendTls10: undefined | false | true;
    disableBackendTls11: undefined | false | true;
    disableFrontendSsl30: undefined | false | true;
    disableFrontendTls10: undefined | false | true;
    disableFrontendTls11: undefined | false | true;
    disableTripleDesChipers: undefined | false | true;
}>;

A security block as defined below.

property signIn

public signIn: pulumi.Output<{
    enabled: boolean;
}>;

A sign_in block as defined below.

property signUp

public signUp: pulumi.Output<{
    enabled: boolean;
    termsOfService: {
        consentRequired: boolean;
        enabled: boolean;
        text: undefined | string;
    };
}>;

A sign_up block as defined below.

property sku

public sku: pulumi.Output<{
    capacity: number;
    name: string;
}>;

A sku block as documented below.

property tags

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

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.

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 testService = pulumi.output(azure.apimanagement.getService({
    name: "example-apim",
    resourceGroupName: "example-resources",
}));
const testProduct = pulumi.all([testService, testService]).apply(([testService, testService1]) => azure.apimanagement.getProduct({
    apiManagementName: testService.name,
    productId: "00000000-0000-0000-0000-000000000000",
    resourceGroupName: testService1.resourceGroupName,
}));
const testUser = pulumi.all([testService, testService]).apply(([testService, testService1]) => azure.apimanagement.getUser({
    apiManagementName: testService.name,
    resourceGroupName: testService1.resourceGroupName,
    userId: "11111111-1111-1111-1111-111111111111",
}));
const testSubscription = new azure.apimanagement.Subscription("test", {
    apiManagementName: testService.apply(testService => testService.name),
    displayName: "Parser API",
    productId: testProduct.apply(testProduct => testProduct.id),
    resourceGroupName: testService.apply(testService => testService.resourceGroupName),
    userId: testUser.apply(testUser => testUser.id),
});

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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>;

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.

class User

extends CustomResource

Manages an API Management User.

Example Usage

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

const testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "West Europe",
    name: "example-resources",
});
const testService = new azure.apimanagement.Service("test", {
    location: testResourceGroup.location,
    name: "example-apim",
    publisherEmail: "company@terraform.io",
    publisherName: "My Company",
    resourceGroupName: testResourceGroup.name,
    sku: {
        capacity: 1,
        name: "Developer",
    },
});
const testUser = new azure.apimanagement.User("test", {
    apiManagementName: testService.name,
    email: "tom+tfdev@hashicorp.com",
    firstName: "Example",
    lastName: "User",
    resourceGroupName: testResourceGroup.name,
    state: "active",
    userId: "5931a75ae4bbd512288c680b",
});

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

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 test = pulumi.output(azure.apimanagement.getApi({
    apiManagementName: "search-api-management",
    name: "search-api",
    resourceGroupName: "search-service",
    revision: "2",
}));

export const apiManagementApiId = test.apply(test => test.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 test = pulumi.output(azure.apimanagement.getGroup({
    apiManagementName: "example-apim",
    name: "my-group",
    resourceGroupName: "search-service",
}));

export const groupType = test.apply(test => test.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 test = pulumi.output(azure.apimanagement.getProduct({
    apiManagementName: "example-apim",
    productId: "my-product",
    resourceGroupName: "search-service",
}));

export const productTerms = test.apply(test => test.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 test = pulumi.output(azure.apimanagement.getService({
    name: "search-api",
    resourceGroupName: "search-service",
}));

export const apiManagementId = test.apply(test => test.id);

function getUser

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

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

Example Usage

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

const test = pulumi.output(azure.apimanagement.getUser({
    apiManagementName: "example-apim",
    resourceGroupName: "search-service",
    userId: "my-user",
}));

export const notes = test.apply(test => test.notes);

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<{
    contentFormat: pulumi.Input<string>;
    contentValue: pulumi.Input<string>;
    wsdlSelector: pulumi.Input<{
        endpointName: pulumi.Input<string>;
        serviceName: pulumi.Input<string>;
    }>;
}>;

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<{
    header: pulumi.Input<string>;
    query: pulumi.Input<string>;
}>;

A subscription_key_parameter_names block as documented below.

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<{
    description: pulumi.Input<string>;
    headers: pulumi.Input<pulumi.Input<{
        defaultValue: pulumi.Input<string>;
        description: pulumi.Input<string>;
        name: pulumi.Input<string>;
        required: pulumi.Input<boolean>;
        type: pulumi.Input<string>;
        values: pulumi.Input<pulumi.Input<string>[]>;
    }>[]>;
    queryParameters: pulumi.Input<pulumi.Input<{
        defaultValue: pulumi.Input<string>;
        description: pulumi.Input<string>;
        name: pulumi.Input<string>;
        required: pulumi.Input<boolean>;
        type: pulumi.Input<string>;
        values: pulumi.Input<pulumi.Input<string>[]>;
    }>[]>;
    representations: pulumi.Input<pulumi.Input<{
        contentType: pulumi.Input<string>;
        formParameters: pulumi.Input<pulumi.Input<{
            defaultValue: pulumi.Input<string>;
            description: pulumi.Input<string>;
            name: pulumi.Input<string>;
            required: pulumi.Input<boolean>;
            type: pulumi.Input<string>;
            values: pulumi.Input<pulumi.Input<string>[]>;
        }>[]>;
        sample: pulumi.Input<string>;
        schemaId: pulumi.Input<string>;
        typeName: pulumi.Input<string>;
    }>[]>;
}>;

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<{
    description: pulumi.Input<string>;
    headers: pulumi.Input<pulumi.Input<{
        defaultValue: pulumi.Input<string>;
        description: pulumi.Input<string>;
        name: pulumi.Input<string>;
        required: pulumi.Input<boolean>;
        type: pulumi.Input<string>;
        values: pulumi.Input<pulumi.Input<string>[]>;
    }>[]>;
    representations: pulumi.Input<pulumi.Input<{
        contentType: pulumi.Input<string>;
        formParameters: pulumi.Input<pulumi.Input<{
            defaultValue: pulumi.Input<string>;
            description: pulumi.Input<string>;
            name: pulumi.Input<string>;
            required: pulumi.Input<boolean>;
            type: pulumi.Input<string>;
            values: pulumi.Input<pulumi.Input<string>[]>;
        }>[]>;
        sample: pulumi.Input<string>;
        schemaId: pulumi.Input<string>;
        typeName: pulumi.Input<string>;
    }>[]>;
    statusCode: pulumi.Input<number>;
}>[]>;

One or more response blocks as defined below.

property templateParameters

templateParameters?: pulumi.Input<pulumi.Input<{
    defaultValue: pulumi.Input<string>;
    description: pulumi.Input<string>;
    name: pulumi.Input<string>;
    required: pulumi.Input<boolean>;
    type: pulumi.Input<string>;
    values: pulumi.Input<pulumi.Input<string>[]>;
}>[]>;

One or more template_parameter 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 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<{
    description: pulumi.Input<string>;
    headers: pulumi.Input<pulumi.Input<{
        defaultValue: pulumi.Input<string>;
        description: pulumi.Input<string>;
        name: pulumi.Input<string>;
        required: pulumi.Input<boolean>;
        type: pulumi.Input<string>;
        values: pulumi.Input<pulumi.Input<string>[]>;
    }>[]>;
    queryParameters: pulumi.Input<pulumi.Input<{
        defaultValue: pulumi.Input<string>;
        description: pulumi.Input<string>;
        name: pulumi.Input<string>;
        required: pulumi.Input<boolean>;
        type: pulumi.Input<string>;
        values: pulumi.Input<pulumi.Input<string>[]>;
    }>[]>;
    representations: pulumi.Input<pulumi.Input<{
        contentType: pulumi.Input<string>;
        formParameters: pulumi.Input<pulumi.Input<{
            defaultValue: pulumi.Input<string>;
            description: pulumi.Input<string>;
            name: pulumi.Input<string>;
            required: pulumi.Input<boolean>;
            type: pulumi.Input<string>;
            values: pulumi.Input<pulumi.Input<string>[]>;
        }>[]>;
        sample: pulumi.Input<string>;
        schemaId: pulumi.Input<string>;
        typeName: pulumi.Input<string>;
    }>[]>;
}>;

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<{
    description: pulumi.Input<string>;
    headers: pulumi.Input<pulumi.Input<{
        defaultValue: pulumi.Input<string>;
        description: pulumi.Input<string>;
        name: pulumi.Input<string>;
        required: pulumi.Input<boolean>;
        type: pulumi.Input<string>;
        values: pulumi.Input<pulumi.Input<string>[]>;
    }>[]>;
    representations: pulumi.Input<pulumi.Input<{
        contentType: pulumi.Input<string>;
        formParameters: pulumi.Input<pulumi.Input<{
            defaultValue: pulumi.Input<string>;
            description: pulumi.Input<string>;
            name: pulumi.Input<string>;
            required: pulumi.Input<boolean>;
            type: pulumi.Input<string>;
            values: pulumi.Input<pulumi.Input<string>[]>;
        }>[]>;
        sample: pulumi.Input<string>;
        schemaId: pulumi.Input<string>;
        typeName: pulumi.Input<string>;
    }>[]>;
    statusCode: pulumi.Input<number>;
}>[]>;

One or more response blocks as defined below.

property templateParameters

templateParameters?: pulumi.Input<pulumi.Input<{
    defaultValue: pulumi.Input<string>;
    description: pulumi.Input<string>;
    name: pulumi.Input<string>;
    required: pulumi.Input<boolean>;
    type: pulumi.Input<string>;
    values: pulumi.Input<pulumi.Input<string>[]>;
}>[]>;

One or more template_parameter 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 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<{
    contentFormat: pulumi.Input<string>;
    contentValue: pulumi.Input<string>;
    wsdlSelector: pulumi.Input<{
        endpointName: pulumi.Input<string>;
        serviceName: pulumi.Input<string>;
    }>;
}>;

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<{
    header: pulumi.Input<string>;
    query: pulumi.Input<string>;
}>;

A subscription_key_parameter_names 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

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

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

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<{
    name: pulumi.Input<string>;
    value: pulumi.Input<string>;
}>[]>;

property tokenEndpoint

tokenEndpoint?: pulumi.Input<string>;

The OAUTH Token Endpoint.

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<{
    name: pulumi.Input<string>;
    value: pulumi.Input<string>;
}>[]>;

property tokenEndpoint

tokenEndpoint?: pulumi.Input<string>;

The OAUTH Token Endpoint.

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

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

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;

id is 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: {
    header: string;
    query: string;
}[];

A subscription_key_parameter_names 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 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

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;

id is 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

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

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;

id is 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

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

A collection of values returned by getService.

property additionalLocations

additionalLocations: {
    gatewayRegionalUrl: string;
    location: string;
    publicIpAddresses: string[];
}[];

One or more additional_location 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: {
    managements: {
        hostName: string;
        keyVaultId: string;
        negotiateClientCertificate: boolean;
    }[];
    portals: {
        hostName: string;
        keyVaultId: string;
        negotiateClientCertificate: boolean;
    }[];
    proxies: {
        defaultSslBinding: boolean;
        hostName: string;
        keyVaultId: string;
        negotiateClientCertificate: boolean;
    }[];
    scms: {
        hostName: string;
        keyVaultId: string;
        negotiateClientCertificate: boolean;
    }[];
}[];

A hostname_configuration block as defined below.

property id

id: string;

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

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 sku

sku: {
    capacity: number;
    name: string;
};

A sku block as documented below.

property tags

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

A mapping of tags assigned to the resource.

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

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;

id is 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

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

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

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

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 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<{
    instrumentationKey: pulumi.Input<string>;
}>;

An application_insights 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<{
    connectionString: pulumi.Input<string>;
    name: pulumi.Input<string>;
}>;

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

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<{
    instrumentationKey: pulumi.Input<string>;
}>;

An application_insights 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<{
    connectionString: pulumi.Input<string>;
    name: pulumi.Input<string>;
}>;

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

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

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

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

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

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

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

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

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

The set of arguments for constructing a Service resource.

property additionalLocation

additionalLocation?: pulumi.Input<{
    gatewayRegionalUrl: pulumi.Input<string>;
    location: pulumi.Input<string>;
    publicIpAddresses: pulumi.Input<pulumi.Input<string>[]>;
}>;

One or more additional_location blocks as defined below.

property certificates

certificates?: pulumi.Input<pulumi.Input<{
    certificatePassword: pulumi.Input<string>;
    encodedCertificate: pulumi.Input<string>;
    storeName: pulumi.Input<string>;
}>[]>;

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

property hostnameConfiguration

hostnameConfiguration?: pulumi.Input<{
    managements: pulumi.Input<pulumi.Input<{
        certificate: pulumi.Input<string>;
        certificatePassword: pulumi.Input<string>;
        hostName: pulumi.Input<string>;
        keyVaultId: pulumi.Input<string>;
        negotiateClientCertificate: pulumi.Input<boolean>;
    }>[]>;
    portals: pulumi.Input<pulumi.Input<{
        certificate: pulumi.Input<string>;
        certificatePassword: pulumi.Input<string>;
        hostName: pulumi.Input<string>;
        keyVaultId: pulumi.Input<string>;
        negotiateClientCertificate: pulumi.Input<boolean>;
    }>[]>;
    proxies: pulumi.Input<pulumi.Input<{
        certificate: pulumi.Input<string>;
        certificatePassword: pulumi.Input<string>;
        defaultSslBinding: pulumi.Input<boolean>;
        hostName: pulumi.Input<string>;
        keyVaultId: pulumi.Input<string>;
        negotiateClientCertificate: pulumi.Input<boolean>;
    }>[]>;
    scms: pulumi.Input<pulumi.Input<{
        certificate: pulumi.Input<string>;
        certificatePassword: pulumi.Input<string>;
        hostName: pulumi.Input<string>;
        keyVaultId: pulumi.Input<string>;
        negotiateClientCertificate: pulumi.Input<boolean>;
    }>[]>;
}>;

A hostname_configuration block as defined below.

property identity

identity?: pulumi.Input<{
    principalId: pulumi.Input<string>;
    tenantId: pulumi.Input<string>;
    type: pulumi.Input<string>;
}>;

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<{
    xmlContent: pulumi.Input<string>;
    xmlLink: pulumi.Input<string>;
}>;

A policy 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<{
    disableBackendSsl30: pulumi.Input<boolean>;
    disableBackendTls10: pulumi.Input<boolean>;
    disableBackendTls11: pulumi.Input<boolean>;
    disableFrontendSsl30: pulumi.Input<boolean>;
    disableFrontendTls10: pulumi.Input<boolean>;
    disableFrontendTls11: pulumi.Input<boolean>;
    disableTripleDesChipers: pulumi.Input<boolean>;
}>;

A security block as defined below.

property signIn

signIn?: pulumi.Input<{
    enabled: pulumi.Input<boolean>;
}>;

A sign_in block as defined below.

property signUp

signUp?: pulumi.Input<{
    enabled: pulumi.Input<boolean>;
    termsOfService: pulumi.Input<{
        consentRequired: pulumi.Input<boolean>;
        enabled: pulumi.Input<boolean>;
        text: pulumi.Input<string>;
    }>;
}>;

A sign_up block as defined below.

property sku

sku: pulumi.Input<{
    capacity: pulumi.Input<number>;
    name: pulumi.Input<string>;
}>;

A sku block as documented below.

property tags

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

A mapping of tags assigned to the resource.

interface ServiceState

Input properties used for looking up and filtering Service resources.

property additionalLocation

additionalLocation?: pulumi.Input<{
    gatewayRegionalUrl: pulumi.Input<string>;
    location: pulumi.Input<string>;
    publicIpAddresses: pulumi.Input<pulumi.Input<string>[]>;
}>;

One or more additional_location blocks as defined below.

property certificates

certificates?: pulumi.Input<pulumi.Input<{
    certificatePassword: pulumi.Input<string>;
    encodedCertificate: pulumi.Input<string>;
    storeName: pulumi.Input<string>;
}>[]>;

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<{
    managements: pulumi.Input<pulumi.Input<{
        certificate: pulumi.Input<string>;
        certificatePassword: pulumi.Input<string>;
        hostName: pulumi.Input<string>;
        keyVaultId: pulumi.Input<string>;
        negotiateClientCertificate: pulumi.Input<boolean>;
    }>[]>;
    portals: pulumi.Input<pulumi.Input<{
        certificate: pulumi.Input<string>;
        certificatePassword: pulumi.Input<string>;
        hostName: pulumi.Input<string>;
        keyVaultId: pulumi.Input<string>;
        negotiateClientCertificate: pulumi.Input<boolean>;
    }>[]>;
    proxies: pulumi.Input<pulumi.Input<{
        certificate: pulumi.Input<string>;
        certificatePassword: pulumi.Input<string>;
        defaultSslBinding: pulumi.Input<boolean>;
        hostName: pulumi.Input<string>;
        keyVaultId: pulumi.Input<string>;
        negotiateClientCertificate: pulumi.Input<boolean>;
    }>[]>;
    scms: pulumi.Input<pulumi.Input<{
        certificate: pulumi.Input<string>;
        certificatePassword: pulumi.Input<string>;
        hostName: pulumi.Input<string>;
        keyVaultId: pulumi.Input<string>;
        negotiateClientCertificate: pulumi.Input<boolean>;
    }>[]>;
}>;

A hostname_configuration block as defined below.

property identity

identity?: pulumi.Input<{
    principalId: pulumi.Input<string>;
    tenantId: pulumi.Input<string>;
    type: pulumi.Input<string>;
}>;

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<{
    xmlContent: pulumi.Input<string>;
    xmlLink: pulumi.Input<string>;
}>;

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 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<{
    disableBackendSsl30: pulumi.Input<boolean>;
    disableBackendTls10: pulumi.Input<boolean>;
    disableBackendTls11: pulumi.Input<boolean>;
    disableFrontendSsl30: pulumi.Input<boolean>;
    disableFrontendTls10: pulumi.Input<boolean>;
    disableFrontendTls11: pulumi.Input<boolean>;
    disableTripleDesChipers: pulumi.Input<boolean>;
}>;

A security block as defined below.

property signIn

signIn?: pulumi.Input<{
    enabled: pulumi.Input<boolean>;
}>;

A sign_in block as defined below.

property signUp

signUp?: pulumi.Input<{
    enabled: pulumi.Input<boolean>;
    termsOfService: pulumi.Input<{
        consentRequired: pulumi.Input<boolean>;
        enabled: pulumi.Input<boolean>;
        text: pulumi.Input<string>;
    }>;
}>;

A sign_up block as defined below.

property sku

sku?: pulumi.Input<{
    capacity: pulumi.Input<number>;
    name: pulumi.Input<string>;
}>;

A sku block as documented below.

property tags

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

A mapping of tags assigned to the resource.

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

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

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

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.