Class Service

Manages an API Management Service.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
    {
        Location = "West Europe",
    });
    var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        PublisherName = "My Company",
        PublisherEmail = "company@exmaple.com",
        SkuName = "Developer_1",
        Policy = new Azure.ApiManagement.Inputs.ServicePolicyArgs
        {
            XmlContent = @"    <policies>
  <inbound />
  <backend />
  <outbound />
  <on-error />
</policies>
",
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Service

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ApiManagement

Assembly: Pulumi.Azure.dll

Syntax

public class Service : CustomResource

Constructors

Service(String, ServiceArgs, CustomResourceOptions)

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

Declaration

public Service(string name, ServiceArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ServiceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AdditionalLocations

One or more additional_location blocks as defined below.

Declaration

public Output<ImmutableArray<ServiceAdditionalLocation>> AdditionalLocations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ServiceAdditionalLocation>>

Certificates

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

Declaration

public Output<ImmutableArray<ServiceCertificate>> Certificates { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ServiceCertificate>>

GatewayRegionalUrl

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

Declaration

public Output<string> GatewayRegionalUrl { get; }

Property Value

Type	Description
Output<System.String>

GatewayUrl

The URL of the Gateway for the API Management Service.

Declaration

public Output<string> GatewayUrl { get; }

Property Value

Type	Description
Output<System.String>

HostnameConfiguration

A hostname_configuration block as defined below.

Declaration

public Output<ServiceHostnameConfiguration> HostnameConfiguration { get; }

Property Value

Type	Description
Output<ServiceHostnameConfiguration>

Identity

An identity block is documented below.

Declaration

public Output<ServiceIdentity> Identity { get; }

Property Value

Type	Description
Output<ServiceIdentity>

Location

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

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

ManagementApiUrl

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

Declaration

public Output<string> ManagementApiUrl { get; }

Property Value

Type	Description
Output<System.String>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NotificationSenderEmail

Email address from which the notification will be sent.

Declaration

public Output<string> NotificationSenderEmail { get; }

Property Value

Type	Description
Output<System.String>

Policy

A policy block as defined below.

Declaration

public Output<ServicePolicy> Policy { get; }

Property Value

Type	Description
Output<ServicePolicy>

PortalUrl

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

Declaration

public Output<string> PortalUrl { get; }

Property Value

Type	Description
Output<System.String>

PrivateIpAddresses

Declaration

public Output<ImmutableArray<string>> PrivateIpAddresses { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Protocols

A protocols block as defined below.

Declaration

public Output<ServiceProtocols> Protocols { get; }

Property Value

Type	Description
Output<ServiceProtocols>

PublicIpAddresses

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

Declaration

public Output<ImmutableArray<string>> PublicIpAddresses { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

PublisherEmail

The email of publisher/company.

Declaration

public Output<string> PublisherEmail { get; }

Property Value

Type	Description
Output<System.String>

PublisherName

The name of publisher/company.

Declaration

public Output<string> PublisherName { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

ScmUrl

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

Declaration

public Output<string> ScmUrl { get; }

Property Value

Type	Description
Output<System.String>

Security

A security block as defined below.

Declaration

public Output<ServiceSecurity> Security { get; }

Property Value

Type	Description
Output<ServiceSecurity>

SignIn

A sign_in block as defined below.

Declaration

public Output<ServiceSignIn> SignIn { get; }

Property Value

Type	Description
Output<ServiceSignIn>

SignUp

A sign_up block as defined below.

Declaration

public Output<ServiceSignUp> SignUp { get; }

Property Value

Type	Description
Output<ServiceSignUp>

SkuName

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

Declaration

public Output<string> SkuName { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags assigned to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

VirtualNetworkConfiguration

A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

Declaration

public Output<ServiceVirtualNetworkConfiguration> VirtualNetworkConfiguration { get; }

Property Value

Type	Description
Output<ServiceVirtualNetworkConfiguration>

VirtualNetworkType

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

Declaration

public Output<string> VirtualNetworkType { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ServiceState, CustomResourceOptions)

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

Declaration

public static Service Get(string name, Input<string> id, ServiceState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ServiceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Service