1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. getService

We recommend using Azure Native.

Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.getService

Start a Neo task
Explain and create an azure.apimanagement.getService resource
azure logo

We recommend using Azure Native.

Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
pulumi/pulumi-azure

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

    Example Usage

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

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

    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)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.ApiManagement.GetService.Invoke(new()
    {
        Name = "search-api",
        ResourceGroupName = "search-service",
    });

    return new Dictionary<string, object?>
    {
        ["apiManagementId"] = example.Apply(getServiceResult => getServiceResult.Id),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.apimanagement.ApimanagementFunctions;
import com.pulumi.azure.apimanagement.inputs.GetServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = ApimanagementFunctions.getService(GetServiceArgs.builder()
            .name("search-api")
            .resourceGroupName("search-service")
            .build());

        ctx.export("apiManagementId", example.id());
    }
}

    variables:
  example:
    fn::invoke:
      function: azure:apimanagement:getService
      arguments:
        name: search-api
        resourceGroupName: search-service
outputs:
  apiManagementId: ${example.id}

    API Providers

    This data source uses the following Azure API Providers:

    • Microsoft.ApiManagement - 2024-05-01, 2022-08-01

    Using getService

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>
    def get_service(name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
    func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput

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

    public static class GetService 
{
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure:apimanagement/getService:getService
  arguments:
    # arguments dictionary

    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.
    Tags Dictionary<string, string>
    A mapping of tags assigned to the resource.
    Name string
    The name of the API Management service.
    ResourceGroupName string
    The Name of the Resource Group in which the API Management Service exists.
    Tags map[string]string
    A mapping of tags assigned to the resource.
    name String
    The name of the API Management service.
    resourceGroupName String
    The Name of the Resource Group in which the API Management Service exists.
    tags Map<String,String>
    A mapping of tags assigned to the resource.
    name string
    The name of the API Management service.
    resourceGroupName string
    The Name of the Resource Group in which the API Management Service exists.
    tags {[key: string]: string}
    A mapping of tags assigned to the resource.
    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.
    tags Mapping[str, str]
    A mapping of tags assigned to the resource.
    name String
    The name of the API Management service.
    resourceGroupName String
    The Name of the Resource Group in which the API Management Service exists.
    tags Map<String>
    A mapping of tags assigned to the resource.

    getService Result

    The following output properties are available:

    AdditionalLocations List<GetServiceAdditionalLocation>
    Zero 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>
    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.
    PrivateIpAddresses List<string>
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    PublicIpAddressId string
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    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
    TenantAccesses List<GetServiceTenantAccess>
    A tenant_access block as defined below.
    Tags Dictionary<string, string>
    A mapping of tags assigned to the resource.
    AdditionalLocations []GetServiceAdditionalLocation
    Zero 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
    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.
    PrivateIpAddresses []string
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    PublicIpAddressId string
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    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
    TenantAccesses []GetServiceTenantAccess
    A tenant_access block as defined below.
    Tags map[string]string
    A mapping of tags assigned to the resource.
    additionalLocations List<GetServiceAdditionalLocation>
    Zero 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>
    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.
    privateIpAddresses List<String>
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    publicIpAddressId String
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    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
    tenantAccesses List<GetServiceTenantAccess>
    A tenant_access block as defined below.
    tags Map<String,String>
    A mapping of tags assigned to the resource.
    additionalLocations GetServiceAdditionalLocation[]
    Zero 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[]
    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.
    privateIpAddresses string[]
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    publicIpAddressId string
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    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
    tenantAccesses GetServiceTenantAccess[]
    A tenant_access block as defined below.
    tags {[key: string]: string}
    A mapping of tags assigned to the resource.
    additional_locations Sequence[GetServiceAdditionalLocation]
    Zero 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 Sequence[GetServiceHostnameConfiguration]
    A hostname_configuration block as defined below.
    id str
    The provider-assigned unique ID for this managed resource.
    identities Sequence[GetServiceIdentity]
    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.
    private_ip_addresses Sequence[str]
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    public_ip_address_id str
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    public_ip_addresses Sequence[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
    tenant_accesses Sequence[GetServiceTenantAccess]
    A tenant_access block as defined below.
    tags Mapping[str, str]
    A mapping of tags assigned to the resource.
    additionalLocations List<Property Map>
    Zero 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<Property Map>
    A hostname_configuration block as defined below.
    id String
    The provider-assigned unique ID for this managed resource.
    identities List<Property Map>
    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.
    privateIpAddresses List<String>
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    publicIpAddressId String
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    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
    tenantAccesses List<Property Map>
    A tenant_access block as defined below.
    tags Map<String>
    A mapping of tags assigned to the resource.

    Supporting Types

    GetServiceAdditionalLocation

    Capacity int
    Specifies the number of units associated with this API Management service.
    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.
    PrivateIpAddresses List<string>
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    PublicIpAddressId string
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    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.
    Zones List<string>
    List of the availability zones where API Management is deployed in the additional region exists.
    Capacity int
    Specifies the number of units associated with this API Management service.
    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.
    PrivateIpAddresses []string
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    PublicIpAddressId string
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    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.
    Zones []string
    List of the availability zones where API Management is deployed in the additional region exists.
    capacity Integer
    Specifies the number of units associated with this API Management service.
    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.
    privateIpAddresses List<String>
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    publicIpAddressId String
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    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.
    zones List<String>
    List of the availability zones where API Management is deployed in the additional region exists.
    capacity number
    Specifies the number of units associated with this API Management service.
    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.
    privateIpAddresses string[]
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    publicIpAddressId string
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    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.
    zones string[]
    List of the availability zones where API Management is deployed in the additional region exists.
    capacity int
    Specifies the number of units associated with this API Management service.
    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.
    private_ip_addresses Sequence[str]
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    public_ip_address_id str
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    public_ip_addresses Sequence[str]
    Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.
    zones Sequence[str]
    List of the availability zones where API Management is deployed in the additional region exists.
    capacity Number
    Specifies the number of units associated with this API Management service.
    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.
    privateIpAddresses List<String>
    Private IP addresses of the API Management service in the additional location, for instances using virtual network mode.
    publicIpAddressId String
    ID of the standard SKU IPv4 Public IP. Available only for Premium SKU deployed in a virtual network.
    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.
    zones List<String>
    List of the availability zones where API Management is deployed in the additional region exists.

    GetServiceHostnameConfiguration

    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.
    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.
    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.
    developer_portals Sequence[GetServiceHostnameConfigurationDeveloperPortal]
    One or more developer_portal blocks as documented below.
    managements Sequence[GetServiceHostnameConfigurationManagement]
    One or more management blocks as documented below.
    portals Sequence[GetServiceHostnameConfigurationPortal]
    One or more portal blocks as documented below.
    proxies Sequence[GetServiceHostnameConfigurationProxy]
    One or more proxy blocks as documented below.
    scms Sequence[GetServiceHostnameConfigurationScm]
    One or more scm blocks as documented below.
    developerPortals List<Property Map>
    One or more developer_portal blocks as documented below.
    managements List<Property Map>
    One or more management blocks as documented below.
    portals List<Property Map>
    One or more portal blocks as documented below.
    proxies List<Property Map>
    One or more proxy blocks as documented below.
    scms List<Property Map>
    One or more scm blocks as documented below.

    GetServiceHostnameConfigurationDeveloperPortal

    HostName string
    The Hostname used for the SCM URL.
    KeyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    KeyVaultId string
    NegotiateClientCertificate bool
    Is Client Certificate Negotiation enabled?
    HostName string
    The Hostname used for the SCM URL.
    KeyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    KeyVaultId string
    NegotiateClientCertificate bool
    Is Client Certificate Negotiation enabled?
    hostName String
    The Hostname used for the SCM URL.
    keyVaultCertificateId String
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId String
    negotiateClientCertificate Boolean
    Is Client Certificate Negotiation enabled?
    hostName string
    The Hostname used for the SCM URL.
    keyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId string
    negotiateClientCertificate boolean
    Is Client Certificate Negotiation enabled?
    host_name str
    The Hostname used for the SCM URL.
    key_vault_certificate_id str
    The ID of the Key Vault Secret which contains the SSL Certificate.
    key_vault_id str
    negotiate_client_certificate bool
    Is Client Certificate Negotiation enabled?
    hostName String
    The Hostname used for the SCM URL.
    keyVaultCertificateId String
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId String
    negotiateClientCertificate Boolean
    Is Client Certificate Negotiation enabled?

    GetServiceHostnameConfigurationManagement

    HostName string
    The Hostname used for the SCM URL.
    KeyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    KeyVaultId string
    NegotiateClientCertificate bool
    Is Client Certificate Negotiation enabled?
    HostName string
    The Hostname used for the SCM URL.
    KeyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    KeyVaultId string
    NegotiateClientCertificate bool
    Is Client Certificate Negotiation enabled?
    hostName String
    The Hostname used for the SCM URL.
    keyVaultCertificateId String
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId String
    negotiateClientCertificate Boolean
    Is Client Certificate Negotiation enabled?
    hostName string
    The Hostname used for the SCM URL.
    keyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId string
    negotiateClientCertificate boolean
    Is Client Certificate Negotiation enabled?
    host_name str
    The Hostname used for the SCM URL.
    key_vault_certificate_id str
    The ID of the Key Vault Secret which contains the SSL Certificate.
    key_vault_id str
    negotiate_client_certificate bool
    Is Client Certificate Negotiation enabled?
    hostName String
    The Hostname used for the SCM URL.
    keyVaultCertificateId String
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId String
    negotiateClientCertificate Boolean
    Is Client Certificate Negotiation enabled?

    GetServiceHostnameConfigurationPortal

    HostName string
    The Hostname used for the SCM URL.
    KeyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    KeyVaultId string
    NegotiateClientCertificate bool
    Is Client Certificate Negotiation enabled?
    HostName string
    The Hostname used for the SCM URL.
    KeyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    KeyVaultId string
    NegotiateClientCertificate bool
    Is Client Certificate Negotiation enabled?
    hostName String
    The Hostname used for the SCM URL.
    keyVaultCertificateId String
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId String
    negotiateClientCertificate Boolean
    Is Client Certificate Negotiation enabled?
    hostName string
    The Hostname used for the SCM URL.
    keyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId string
    negotiateClientCertificate boolean
    Is Client Certificate Negotiation enabled?
    host_name str
    The Hostname used for the SCM URL.
    key_vault_certificate_id str
    The ID of the Key Vault Secret which contains the SSL Certificate.
    key_vault_id str
    negotiate_client_certificate bool
    Is Client Certificate Negotiation enabled?
    hostName String
    The Hostname used for the SCM URL.
    keyVaultCertificateId String
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId String
    negotiateClientCertificate Boolean
    Is Client Certificate Negotiation enabled?

    GetServiceHostnameConfigurationProxy

    DefaultSslBinding bool
    Is this the default SSL Binding?
    HostName string
    The Hostname used for the SCM URL.
    KeyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    KeyVaultId string
    NegotiateClientCertificate bool
    Is Client Certificate Negotiation enabled?
    DefaultSslBinding bool
    Is this the default SSL Binding?
    HostName string
    The Hostname used for the SCM URL.
    KeyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    KeyVaultId string
    NegotiateClientCertificate bool
    Is Client Certificate Negotiation enabled?
    defaultSslBinding Boolean
    Is this the default SSL Binding?
    hostName String
    The Hostname used for the SCM URL.
    keyVaultCertificateId String
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId String
    negotiateClientCertificate Boolean
    Is Client Certificate Negotiation enabled?
    defaultSslBinding boolean
    Is this the default SSL Binding?
    hostName string
    The Hostname used for the SCM URL.
    keyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId string
    negotiateClientCertificate boolean
    Is Client Certificate Negotiation enabled?
    default_ssl_binding bool
    Is this the default SSL Binding?
    host_name str
    The Hostname used for the SCM URL.
    key_vault_certificate_id str
    The ID of the Key Vault Secret which contains the SSL Certificate.
    key_vault_id str
    negotiate_client_certificate bool
    Is Client Certificate Negotiation enabled?
    defaultSslBinding Boolean
    Is this the default SSL Binding?
    hostName String
    The Hostname used for the SCM URL.
    keyVaultCertificateId String
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId String
    negotiateClientCertificate Boolean
    Is Client Certificate Negotiation enabled?

    GetServiceHostnameConfigurationScm

    HostName string
    The Hostname used for the SCM URL.
    KeyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    KeyVaultId string
    NegotiateClientCertificate bool
    Is Client Certificate Negotiation enabled?
    HostName string
    The Hostname used for the SCM URL.
    KeyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    KeyVaultId string
    NegotiateClientCertificate bool
    Is Client Certificate Negotiation enabled?
    hostName String
    The Hostname used for the SCM URL.
    keyVaultCertificateId String
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId String
    negotiateClientCertificate Boolean
    Is Client Certificate Negotiation enabled?
    hostName string
    The Hostname used for the SCM URL.
    keyVaultCertificateId string
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId string
    negotiateClientCertificate boolean
    Is Client Certificate Negotiation enabled?
    host_name str
    The Hostname used for the SCM URL.
    key_vault_certificate_id str
    The ID of the Key Vault Secret which contains the SSL Certificate.
    key_vault_id str
    negotiate_client_certificate bool
    Is Client Certificate Negotiation enabled?
    hostName String
    The Hostname used for the SCM URL.
    keyVaultCertificateId String
    The ID of the Key Vault Secret which contains the SSL Certificate.
    keyVaultId String
    negotiateClientCertificate Boolean
    Is Client Certificate Negotiation enabled?

    GetServiceIdentity

    IdentityIds List<string>
    The list of User Assigned Managed Identity IDs assigned to this API Management Service.
    PrincipalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
    TenantId string
    The ID of the Tenant which has access to this API Management instance.
    Type string
    The type of Managed Service Identity that is configured on this API Management Service.
    IdentityIds []string
    The list of User Assigned Managed Identity IDs assigned to this API Management Service.
    PrincipalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
    TenantId string
    The ID of the Tenant which has access to this API Management instance.
    Type string
    The type of Managed Service Identity that is configured on this API Management Service.
    identityIds List<String>
    The list of User Assigned Managed Identity IDs assigned to this API Management Service.
    principalId String
    The Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
    tenantId String
    The ID of the Tenant which has access to this API Management instance.
    type String
    The type of Managed Service Identity that is configured on this API Management Service.
    identityIds string[]
    The list of User Assigned Managed Identity IDs assigned to this API Management Service.
    principalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
    tenantId string
    The ID of the Tenant which has access to this API Management instance.
    type string
    The type of Managed Service Identity that is configured on this API Management Service.
    identity_ids Sequence[str]
    The list of User Assigned Managed Identity IDs assigned to this API Management Service.
    principal_id str
    The Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
    tenant_id str
    The ID of the Tenant which has access to this API Management instance.
    type str
    The type of Managed Service Identity that is configured on this API Management Service.
    identityIds List<String>
    The list of User Assigned Managed Identity IDs assigned to this API Management Service.
    principalId String
    The Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.
    tenantId String
    The ID of the Tenant which has access to this API Management instance.
    type String
    The type of Managed Service Identity that is configured on this API Management Service.

    GetServiceTenantAccess

    Enabled bool
    Is access to the Management API enabled (presumably "for this Tenant")?
    PrimaryKey string
    Primary access key for the tenant access information contract.
    SecondaryKey string
    Secondary access key for the tenant access information contract.
    TenantId string
    The ID of the Tenant which has access to this API Management instance.
    Enabled bool
    Is access to the Management API enabled (presumably "for this Tenant")?
    PrimaryKey string
    Primary access key for the tenant access information contract.
    SecondaryKey string
    Secondary access key for the tenant access information contract.
    TenantId string
    The ID of the Tenant which has access to this API Management instance.
    enabled Boolean
    Is access to the Management API enabled (presumably "for this Tenant")?
    primaryKey String
    Primary access key for the tenant access information contract.
    secondaryKey String
    Secondary access key for the tenant access information contract.
    tenantId String
    The ID of the Tenant which has access to this API Management instance.
    enabled boolean
    Is access to the Management API enabled (presumably "for this Tenant")?
    primaryKey string
    Primary access key for the tenant access information contract.
    secondaryKey string
    Secondary access key for the tenant access information contract.
    tenantId string
    The ID of the Tenant which has access to this API Management instance.
    enabled bool
    Is access to the Management API enabled (presumably "for this Tenant")?
    primary_key str
    Primary access key for the tenant access information contract.
    secondary_key str
    Secondary access key for the tenant access information contract.
    tenant_id str
    The ID of the Tenant which has access to this API Management instance.
    enabled Boolean
    Is access to the Management API enabled (presumably "for this Tenant")?
    primaryKey String
    Primary access key for the tenant access information contract.
    secondaryKey String
    Secondary access key for the tenant access information contract.
    tenantId String
    The ID of the Tenant which has access to this API Management instance.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
    pulumi/pulumi-azure
      Meet Neo: Your AI Platform Teammate