GetService

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.ApiManagement.GetService.InvokeAsync(new Azure.ApiManagement.GetServiceArgs
        {
            Name = "search-api",
            ResourceGroupName = "search-service",
        }));
        this.ApiManagementId = example.Apply(example => example.Id);
    }

    [Output("apiManagementId")]
    public Output<string> ApiManagementId { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/apimanagement"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := apimanagement.LookupService(ctx, &apimanagement.LookupServiceArgs{
            Name:              "search-api",
            ResourceGroupName: "search-service",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("apiManagementId", example.Id)
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.apimanagement.get_service(name="search-api",
    resource_group_name="search-service")
pulumi.export("apiManagementId", example.id)

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

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

Using GetService

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

function  get_service(name=None, resource_group_name=None, opts=None)

func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)

Note: This function is named LookupService in the Go SDK.

public static class GetService {
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: The name of the API Management service.
ResourceGroupName string: The Name of the Resource Group in which the API Management Service exists.

Name string: The name of the API Management service.
ResourceGroupName string: The Name of the Resource Group in which the API Management Service exists.

name string: The name of the API Management service.
resourceGroupName string: The Name of the Resource Group in which the API Management Service exists.

name str: The name of the API Management service.
resource_group_name str: The Name of the Resource Group in which the API Management Service exists.

GetService Result

The following output properties are available:

AdditionalLocations List<GetServiceAdditionalLocation>: One or more additional_location blocks as defined below
DeveloperPortalUrl string: The URL for the Developer Portal associated with this API Management service.
GatewayRegionalUrl string: Gateway URL of the API Management service in the Region.
GatewayUrl string: The URL for the API Management Service’s Gateway.
HostnameConfigurations List<GetServiceHostnameConfiguration>: A hostname_configuration block as defined below.
Id string: The provider-assigned unique ID for this managed resource.
Identities List<GetServiceIdentity>: (Optional) An identity block as defined below.
Location string: The location name of the additional region among Azure Data center regions.
ManagementApiUrl string: The URL for the Management API.
Name string: Specifies the plan’s pricing tier.
NotificationSenderEmail string: The email address from which the notification will be sent.
PortalUrl string: The URL of the Publisher Portal.
PublicIpAddresses List<string>: Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.
PublisherEmail string: The email of Publisher/Company of the API Management Service.
PublisherName string: The name of the Publisher/Company of the API Management Service.
ResourceGroupName string
ScmUrl string: The SCM (Source Code Management) endpoint.
SkuName string
Tags Dictionary<string, string>: A mapping of tags assigned to the resource.

AdditionalLocations []GetServiceAdditionalLocation: One or more additional_location blocks as defined below
DeveloperPortalUrl string: The URL for the Developer Portal associated with this API Management service.
GatewayRegionalUrl string: Gateway URL of the API Management service in the Region.
GatewayUrl string: The URL for the API Management Service’s Gateway.
HostnameConfigurations []GetServiceHostnameConfiguration: A hostname_configuration block as defined below.
Id string: The provider-assigned unique ID for this managed resource.
Identities []GetServiceIdentity: (Optional) An identity block as defined below.
Location string: The location name of the additional region among Azure Data center regions.
ManagementApiUrl string: The URL for the Management API.
Name string: Specifies the plan’s pricing tier.
NotificationSenderEmail string: The email address from which the notification will be sent.
PortalUrl string: The URL of the Publisher Portal.
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.
PublisherEmail string: The email of Publisher/Company of the API Management Service.
PublisherName string: The name of the Publisher/Company of the API Management Service.
ResourceGroupName string
ScmUrl string: The SCM (Source Code Management) endpoint.
SkuName string
Tags map[string]string: A mapping of tags assigned to the resource.

additionalLocations GetServiceAdditionalLocation[]: One or more additional_location blocks as defined below
developerPortalUrl string: The URL for the Developer Portal associated with this API Management service.
gatewayRegionalUrl string: Gateway URL of the API Management service in the Region.
gatewayUrl string: The URL for the API Management Service’s Gateway.
hostnameConfigurations GetServiceHostnameConfiguration[]: A hostname_configuration block as defined below.
id string: The provider-assigned unique ID for this managed resource.
identities GetServiceIdentity[]: (Optional) An identity block as defined below.
location string: The location name of the additional region among Azure Data center regions.
managementApiUrl string: The URL for the Management API.
name string: Specifies the plan’s pricing tier.
notificationSenderEmail string: The email address from which the notification will be sent.
portalUrl string: The URL of the Publisher Portal.
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.
publisherEmail string: The email of Publisher/Company of the API Management Service.
publisherName string: The name of the Publisher/Company of the API Management Service.
resourceGroupName string
scmUrl string: The SCM (Source Code Management) endpoint.
skuName string
tags {[key: string]: string}: A mapping of tags assigned to the resource.

additional_locations List[GetServiceAdditionalLocation]: One or more additional_location blocks as defined below
developer_portal_url str: The URL for the Developer Portal associated with this API Management service.
gateway_regional_url str: Gateway URL of the API Management service in the Region.
gateway_url str: The URL for the API Management Service’s Gateway.
hostname_configurations List[GetServiceHostnameConfiguration]: A hostname_configuration block as defined below.
id str: The provider-assigned unique ID for this managed resource.
identities List[GetServiceIdentity]: (Optional) An identity block as defined below.
location str: The location name of the additional region among Azure Data center regions.
management_api_url str: The URL for the Management API.
name str: Specifies the plan’s pricing tier.
notification_sender_email str: The email address from which the notification will be sent.
portal_url str: The URL of the Publisher Portal.
public_ip_addresses List[str]: Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.
publisher_email str: The email of Publisher/Company of the API Management Service.
publisher_name str: The name of the Publisher/Company of the API Management Service.
resource_group_name str
scm_url str: The SCM (Source Code Management) endpoint.
sku_name str
tags Dict[str, str]: A mapping of tags assigned to the resource.

Supporting Types

GetServiceAdditionalLocation

See the output API doc for this type.

GatewayRegionalUrl string: Gateway URL of the API Management service in the Region.
Location string: The location name of the additional region among Azure Data center regions.
PublicIpAddresses List<string>: Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.

GatewayRegionalUrl string: Gateway URL of the API Management service in the Region.
Location string: The location name of the additional region among Azure Data center regions.
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.

gatewayRegionalUrl string: Gateway URL of the API Management service in the Region.
location string: The location name of the additional region among Azure Data center regions.
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.

gateway_regional_url str: Gateway URL of the API Management service in the Region.
location str: The location name of the additional region among Azure Data center regions.
public_ip_addresses List[str]: Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.

GetServiceHostnameConfiguration

See the output API doc for this type.

DeveloperPortals List<GetServiceHostnameConfigurationDeveloperPortalArgs>: One or more developer_portal blocks as documented below.
Managements List<GetServiceHostnameConfigurationManagementArgs>: One or more management blocks as documented below.
Portals List<GetServiceHostnameConfigurationPortalArgs>: One or more portal blocks as documented below.
Proxies List<GetServiceHostnameConfigurationProxyArgs>: One or more proxy blocks as documented below.
Scms List<GetServiceHostnameConfigurationScmArgs>: One or more scm blocks as documented below.

DeveloperPortals []GetServiceHostnameConfigurationDeveloperPortal: One or more developer_portal blocks as documented below.
Managements []GetServiceHostnameConfigurationManagement: One or more management blocks as documented below.
Portals []GetServiceHostnameConfigurationPortal: One or more portal blocks as documented below.
Proxies []GetServiceHostnameConfigurationProxy: One or more proxy blocks as documented below.
Scms []GetServiceHostnameConfigurationScm: One or more scm blocks as documented below.

developerPortals GetServiceHostnameConfigurationDeveloperPortal[]: One or more developer_portal blocks as documented below.
managements GetServiceHostnameConfigurationManagement[]: One or more management blocks as documented below.
portals GetServiceHostnameConfigurationPortal[]: One or more portal blocks as documented below.
proxies GetServiceHostnameConfigurationProxy[]: One or more proxy blocks as documented below.
scms GetServiceHostnameConfigurationScm[]: One or more scm blocks as documented below.

developerPortals List[GetServiceHostnameConfigurationDeveloperPortal]: One or more developer_portal blocks as documented below.
managements List[GetServiceHostnameConfigurationManagement]: One or more management blocks as documented below.
portals List[GetServiceHostnameConfigurationPortal]: One or more portal blocks as documented below.
proxies List[GetServiceHostnameConfigurationProxy]: One or more proxy blocks as documented below.
scms List[GetServiceHostnameConfigurationScm]: One or more scm blocks as documented below.

GetServiceHostnameConfigurationDeveloperPortal

See the output API doc for this type.

HostName string: The Hostname used for the SCM URL.
KeyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
NegotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

HostName string: The Hostname used for the SCM URL.
KeyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
NegotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

hostName string: The Hostname used for the SCM URL.
keyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
negotiateClientCertificate boolean: Is Client Certificate Negotiation enabled?

host_name str: The Hostname used for the SCM URL.
key_vault_id str: The ID of the Key Vault Secret which contains the SSL Certificate.
negotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

GetServiceHostnameConfigurationManagement

See the output API doc for this type.

HostName string: The Hostname used for the SCM URL.
KeyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
NegotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

HostName string: The Hostname used for the SCM URL.
KeyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
NegotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

hostName string: The Hostname used for the SCM URL.
keyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
negotiateClientCertificate boolean: Is Client Certificate Negotiation enabled?

host_name str: The Hostname used for the SCM URL.
key_vault_id str: The ID of the Key Vault Secret which contains the SSL Certificate.
negotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

GetServiceHostnameConfigurationPortal

See the output API doc for this type.

HostName string: The Hostname used for the SCM URL.
KeyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
NegotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

HostName string: The Hostname used for the SCM URL.
KeyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
NegotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

hostName string: The Hostname used for the SCM URL.
keyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
negotiateClientCertificate boolean: Is Client Certificate Negotiation enabled?

host_name str: The Hostname used for the SCM URL.
key_vault_id str: The ID of the Key Vault Secret which contains the SSL Certificate.
negotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

GetServiceHostnameConfigurationProxy

See the output API doc for this type.

DefaultSslBinding bool: Is this the default SSL Binding?
HostName string: The Hostname used for the SCM URL.
KeyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
NegotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

DefaultSslBinding bool: Is this the default SSL Binding?
HostName string: The Hostname used for the SCM URL.
KeyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
NegotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

defaultSslBinding boolean: Is this the default SSL Binding?
hostName string: The Hostname used for the SCM URL.
keyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
negotiateClientCertificate boolean: Is Client Certificate Negotiation enabled?

defaultSslBinding bool: Is this the default SSL Binding?
host_name str: The Hostname used for the SCM URL.
key_vault_id str: The ID of the Key Vault Secret which contains the SSL Certificate.
negotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

GetServiceHostnameConfigurationScm

See the output API doc for this type.

HostName string: The Hostname used for the SCM URL.
KeyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
NegotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

HostName string: The Hostname used for the SCM URL.
KeyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
NegotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

hostName string: The Hostname used for the SCM URL.
keyVaultId string: The ID of the Key Vault Secret which contains the SSL Certificate.
negotiateClientCertificate boolean: Is Client Certificate Negotiation enabled?

host_name str: The Hostname used for the SCM URL.
key_vault_id str: The ID of the Key Vault Secret which contains the SSL Certificate.
negotiateClientCertificate bool: Is Client Certificate Negotiation enabled?

GetServiceIdentity

See the output API doc for this type.

IdentityIds List<string>: A list of IDs for User Assigned Managed Identity resources to be assigned.
PrincipalId string: Specifies the Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
TenantId string: Specifies the Tenant ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
Type string: Specifies the type of Managed Service Identity that is configured on this API Management Service.

IdentityIds []string: A list of IDs for User Assigned Managed Identity resources to be assigned.
PrincipalId string: Specifies the Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
TenantId string: Specifies the Tenant ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
Type string: Specifies the type of Managed Service Identity that is configured on this API Management Service.

identityIds string[]: A list of IDs for User Assigned Managed Identity resources to be assigned.
principalId string: Specifies the Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
tenantId string: Specifies the Tenant ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
type string: Specifies the type of Managed Service Identity that is configured on this API Management Service.

identityIds List[str]: A list of IDs for User Assigned Managed Identity resources to be assigned.
principal_id str: Specifies the Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
tenant_id str: Specifies the Tenant ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
type str: Specifies the type of Managed Service Identity that is configured on this API Management Service.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetService

Example Usage

Using GetService

GetService Result

Supporting Types

GetServiceAdditionalLocation

GetServiceHostnameConfiguration

GetServiceHostnameConfigurationDeveloperPortal

GetServiceHostnameConfigurationManagement

GetServiceHostnameConfigurationPortal

GetServiceHostnameConfigurationProxy

GetServiceHostnameConfigurationScm

GetServiceIdentity

Package Details

On This Page