Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.0 published on Wednesday, May 4, 2022 by Pulumi

getApiManagementService

A single API Management service resource in List or Get response. API Version: 2020-12-01.

Using getApiManagementService

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 getApiManagementService(args: GetApiManagementServiceArgs, opts?: InvokeOptions): Promise<GetApiManagementServiceResult>
function getApiManagementServiceOutput(args: GetApiManagementServiceOutputArgs, opts?: InvokeOptions): Output<GetApiManagementServiceResult>
def get_api_management_service(resource_group_name: Optional[str] = None,
                               service_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetApiManagementServiceResult
def get_api_management_service_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                               service_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetApiManagementServiceResult]
func LookupApiManagementService(ctx *Context, args *LookupApiManagementServiceArgs, opts ...InvokeOption) (*LookupApiManagementServiceResult, error)
func LookupApiManagementServiceOutput(ctx *Context, args *LookupApiManagementServiceOutputArgs, opts ...InvokeOption) LookupApiManagementServiceResultOutput

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

public static class GetApiManagementService 
{
    public static Task<GetApiManagementServiceResult> InvokeAsync(GetApiManagementServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetApiManagementServiceResult> Invoke(GetApiManagementServiceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetApiManagementServiceResult> getApiManagementService(GetApiManagementServiceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:apimanagement:getApiManagementService
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

getApiManagementService Result

The following output properties are available:

CreatedAtUtc string

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

DeveloperPortalUrl string

DEveloper Portal endpoint URL of the API Management service.

Etag string

ETag of the resource.

GatewayRegionalUrl string

Gateway URL of the API Management service in the Default Region.

GatewayUrl string

Gateway URL of the API Management service.

Id string

Resource ID.

Location string

Resource location.

ManagementApiUrl string

Management API endpoint URL of the API Management service.

Name string

Resource name.

PortalUrl string

Publisher portal endpoint Url of the API Management service.

PrivateIPAddresses List<string>

Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.

ProvisioningState string

The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

PublicIPAddresses List<string>

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

PublisherEmail string

Publisher email.

PublisherName string

Publisher name.

ScmUrl string

SCM endpoint URL of the API Management service.

Sku Pulumi.AzureNative.ApiManagement.Outputs.ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

TargetProvisioningState string

The provisioning state of the API Management service, which is targeted by the long running operation started on the service.

Type string

Resource type for API Management resource is set to Microsoft.ApiManagement.

AdditionalLocations List<Pulumi.AzureNative.ApiManagement.Outputs.AdditionalLocationResponse>

Additional datacenter locations of the API Management service.

ApiVersionConstraint Pulumi.AzureNative.ApiManagement.Outputs.ApiVersionConstraintResponse

Control Plane Apis version constraint for the API Management service.

Certificates List<Pulumi.AzureNative.ApiManagement.Outputs.CertificateConfigurationResponse>

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

CustomProperties Dictionary<string, string>

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384

DisableGateway bool

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

EnableClientCertificate bool

Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.

HostnameConfigurations List<Pulumi.AzureNative.ApiManagement.Outputs.HostnameConfigurationResponse>

Custom hostname configuration of the API Management service.

Identity Pulumi.AzureNative.ApiManagement.Outputs.ApiManagementServiceIdentityResponse

Managed service identity of the Api Management service.

NotificationSenderEmail string

Email address from which the notification will be sent.

Restore bool

Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.

Tags Dictionary<string, string>

Resource tags.

VirtualNetworkConfiguration Pulumi.AzureNative.ApiManagement.Outputs.VirtualNetworkConfigurationResponse

Virtual network configuration of the API Management service.

VirtualNetworkType string

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.

Zones List<string>

A list of availability zones denoting where the resource needs to come from.

CreatedAtUtc string

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

DeveloperPortalUrl string

DEveloper Portal endpoint URL of the API Management service.

Etag string

ETag of the resource.

GatewayRegionalUrl string

Gateway URL of the API Management service in the Default Region.

GatewayUrl string

Gateway URL of the API Management service.

Id string

Resource ID.

Location string

Resource location.

ManagementApiUrl string

Management API endpoint URL of the API Management service.

Name string

Resource name.

PortalUrl string

Publisher portal endpoint Url of the API Management service.

PrivateIPAddresses []string

Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.

ProvisioningState string

The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

PublicIPAddresses []string

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

PublisherEmail string

Publisher email.

PublisherName string

Publisher name.

ScmUrl string

SCM endpoint URL of the API Management service.

Sku ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

TargetProvisioningState string

The provisioning state of the API Management service, which is targeted by the long running operation started on the service.

Type string

Resource type for API Management resource is set to Microsoft.ApiManagement.

AdditionalLocations []AdditionalLocationResponse

Additional datacenter locations of the API Management service.

ApiVersionConstraint ApiVersionConstraintResponse

Control Plane Apis version constraint for the API Management service.

Certificates []CertificateConfigurationResponse

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

CustomProperties map[string]string

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384

DisableGateway bool

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

EnableClientCertificate bool

Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.

HostnameConfigurations []HostnameConfigurationResponse

Custom hostname configuration of the API Management service.

Identity ApiManagementServiceIdentityResponse

Managed service identity of the Api Management service.

NotificationSenderEmail string

Email address from which the notification will be sent.

Restore bool

Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.

Tags map[string]string

Resource tags.

VirtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network configuration of the API Management service.

VirtualNetworkType string

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.

Zones []string

A list of availability zones denoting where the resource needs to come from.

createdAtUtc String

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

developerPortalUrl String

DEveloper Portal endpoint URL of the API Management service.

etag String

ETag of the resource.

gatewayRegionalUrl String

Gateway URL of the API Management service in the Default Region.

gatewayUrl String

Gateway URL of the API Management service.

id String

Resource ID.

location String

Resource location.

managementApiUrl String

Management API endpoint URL of the API Management service.

name String

Resource name.

portalUrl String

Publisher portal endpoint Url of the API Management service.

privateIPAddresses List

Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.

provisioningState String

The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

publicIPAddresses List

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

publisherEmail String

Publisher email.

publisherName String

Publisher name.

scmUrl String

SCM endpoint URL of the API Management service.

sku ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

targetProvisioningState String

The provisioning state of the API Management service, which is targeted by the long running operation started on the service.

type String

Resource type for API Management resource is set to Microsoft.ApiManagement.

additionalLocations ListLocationResponse>

Additional datacenter locations of the API Management service.

apiVersionConstraint ApiVersionConstraintResponse

Control Plane Apis version constraint for the API Management service.

certificates ListConfigurationResponse>

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

customProperties Map

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384

disableGateway Boolean

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

enableClientCertificate Boolean

Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.

hostnameConfigurations ListConfigurationResponse>

Custom hostname configuration of the API Management service.

identity ApiManagementServiceIdentityResponse

Managed service identity of the Api Management service.

notificationSenderEmail String

Email address from which the notification will be sent.

restore Boolean

Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.

tags Map

Resource tags.

virtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network configuration of the API Management service.

virtualNetworkType String

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.

zones List

A list of availability zones denoting where the resource needs to come from.

createdAtUtc string

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

developerPortalUrl string

DEveloper Portal endpoint URL of the API Management service.

etag string

ETag of the resource.

gatewayRegionalUrl string

Gateway URL of the API Management service in the Default Region.

gatewayUrl string

Gateway URL of the API Management service.

id string

Resource ID.

location string

Resource location.

managementApiUrl string

Management API endpoint URL of the API Management service.

name string

Resource name.

portalUrl string

Publisher portal endpoint Url of the API Management service.

privateIPAddresses string[]

Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.

provisioningState string

The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

publicIPAddresses string[]

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

publisherEmail string

Publisher email.

publisherName string

Publisher name.

scmUrl string

SCM endpoint URL of the API Management service.

sku ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

targetProvisioningState string

The provisioning state of the API Management service, which is targeted by the long running operation started on the service.

type string

Resource type for API Management resource is set to Microsoft.ApiManagement.

additionalLocations AdditionalLocationResponse[]

Additional datacenter locations of the API Management service.

apiVersionConstraint ApiVersionConstraintResponse

Control Plane Apis version constraint for the API Management service.

certificates CertificateConfigurationResponse[]

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

customProperties {[key: string]: string}

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384

disableGateway boolean

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

enableClientCertificate boolean

Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.

hostnameConfigurations HostnameConfigurationResponse[]

Custom hostname configuration of the API Management service.

identity ApiManagementServiceIdentityResponse

Managed service identity of the Api Management service.

notificationSenderEmail string

Email address from which the notification will be sent.

restore boolean

Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.

tags {[key: string]: string}

Resource tags.

virtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network configuration of the API Management service.

virtualNetworkType string

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.

zones string[]

A list of availability zones denoting where the resource needs to come from.

created_at_utc str

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

developer_portal_url str

DEveloper Portal endpoint URL of the API Management service.

etag str

ETag of the resource.

gateway_regional_url str

Gateway URL of the API Management service in the Default Region.

gateway_url str

Gateway URL of the API Management service.

id str

Resource ID.

location str

Resource location.

management_api_url str

Management API endpoint URL of the API Management service.

name str

Resource name.

portal_url str

Publisher portal endpoint Url of the API Management service.

private_ip_addresses Sequence[str]

Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.

provisioning_state str

The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

public_ip_addresses Sequence[str]

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

publisher_email str

Publisher email.

publisher_name str

Publisher name.

scm_url str

SCM endpoint URL of the API Management service.

sku ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

target_provisioning_state str

The provisioning state of the API Management service, which is targeted by the long running operation started on the service.

type str

Resource type for API Management resource is set to Microsoft.ApiManagement.

additional_locations Sequence[AdditionalLocationResponse]

Additional datacenter locations of the API Management service.

api_version_constraint ApiVersionConstraintResponse

Control Plane Apis version constraint for the API Management service.

certificates Sequence[CertificateConfigurationResponse]

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

custom_properties Mapping[str, str]

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384

disable_gateway bool

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

enable_client_certificate bool

Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.

hostname_configurations Sequence[HostnameConfigurationResponse]

Custom hostname configuration of the API Management service.

identity ApiManagementServiceIdentityResponse

Managed service identity of the Api Management service.

notification_sender_email str

Email address from which the notification will be sent.

restore bool

Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.

tags Mapping[str, str]

Resource tags.

virtual_network_configuration VirtualNetworkConfigurationResponse

Virtual network configuration of the API Management service.

virtual_network_type str

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.

zones Sequence[str]

A list of availability zones denoting where the resource needs to come from.

createdAtUtc String

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

developerPortalUrl String

DEveloper Portal endpoint URL of the API Management service.

etag String

ETag of the resource.

gatewayRegionalUrl String

Gateway URL of the API Management service in the Default Region.

gatewayUrl String

Gateway URL of the API Management service.

id String

Resource ID.

location String

Resource location.

managementApiUrl String

Management API endpoint URL of the API Management service.

name String

Resource name.

portalUrl String

Publisher portal endpoint Url of the API Management service.

privateIPAddresses List

Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.

provisioningState String

The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

publicIPAddresses List

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

publisherEmail String

Publisher email.

publisherName String

Publisher name.

scmUrl String

SCM endpoint URL of the API Management service.

sku Property Map

SKU properties of the API Management service.

targetProvisioningState String

The provisioning state of the API Management service, which is targeted by the long running operation started on the service.

type String

Resource type for API Management resource is set to Microsoft.ApiManagement.

additionalLocations List

Additional datacenter locations of the API Management service.

apiVersionConstraint Property Map

Control Plane Apis version constraint for the API Management service.

certificates List

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

customProperties Map

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384

disableGateway Boolean

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

enableClientCertificate Boolean

Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.

hostnameConfigurations List

Custom hostname configuration of the API Management service.

identity Property Map

Managed service identity of the Api Management service.

notificationSenderEmail String

Email address from which the notification will be sent.

restore Boolean

Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.

tags Map

Resource tags.

virtualNetworkConfiguration Property Map

Virtual network configuration of the API Management service.

virtualNetworkType String

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.

zones List

A list of availability zones denoting where the resource needs to come from.

Supporting Types

AdditionalLocationResponse

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 Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.

PublicIPAddresses List<string>

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

Sku Pulumi.AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

DisableGateway bool

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

VirtualNetworkConfiguration Pulumi.AzureNative.ApiManagement.Inputs.VirtualNetworkConfigurationResponse

Virtual network configuration for the location.

Zones List<string>

A list of availability zones denoting where the resource needs to come from.

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 Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.

PublicIPAddresses []string

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

Sku ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

DisableGateway bool

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

VirtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network configuration for the location.

Zones []string

A list of availability zones denoting where the resource needs to come from.

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

Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.

publicIPAddresses List

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

sku ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

disableGateway Boolean

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

virtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network configuration for the location.

zones List

A list of availability zones denoting where the resource needs to come from.

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 Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.

publicIPAddresses string[]

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

sku ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

disableGateway boolean

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

virtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network configuration for the location.

zones string[]

A list of availability zones denoting where the resource needs to come from.

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 Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.

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, Premium and Isolated SKU.

sku ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

disable_gateway bool

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

virtual_network_configuration VirtualNetworkConfigurationResponse

Virtual network configuration for the location.

zones Sequence[str]

A list of availability zones denoting where the resource needs to come from.

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

Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.

publicIPAddresses List

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

sku Property Map

SKU properties of the API Management service.

disableGateway Boolean

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

virtualNetworkConfiguration Property Map

Virtual network configuration for the location.

zones List

A list of availability zones denoting where the resource needs to come from.

ApiManagementServiceIdentityResponse

PrincipalId string

The principal id of the identity.

TenantId string

The client tenant id of the identity.

Type string

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.ApiManagement.Inputs.UserIdentityPropertiesResponse>

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

PrincipalId string

The principal id of the identity.

TenantId string

The client tenant id of the identity.

Type string

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

UserAssignedIdentities map[string]UserIdentityPropertiesResponse

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principalId String

The principal id of the identity.

tenantId String

The client tenant id of the identity.

type String

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

userAssignedIdentities MapIdentityPropertiesResponse>

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principalId string

The principal id of the identity.

tenantId string

The client tenant id of the identity.

type string

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

userAssignedIdentities {[key: string]: UserIdentityPropertiesResponse}

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principal_id str

The principal id of the identity.

tenant_id str

The client tenant id of the identity.

type str

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

user_assigned_identities Mapping[str, UserIdentityPropertiesResponse]

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principalId String

The principal id of the identity.

tenantId String

The client tenant id of the identity.

type String

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

userAssignedIdentities Map

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceSkuPropertiesResponse

Capacity int

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

Name string

Name of the Sku.

Capacity int

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

Name string

Name of the Sku.

capacity Integer

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

name String

Name of the Sku.

capacity number

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

name string

Name of the Sku.

capacity int

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

name str

Name of the Sku.

capacity Number

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

name String

Name of the Sku.

ApiVersionConstraintResponse

MinApiVersion string

Limit control plane API calls to API Management service with version equal to or newer than this value.

MinApiVersion string

Limit control plane API calls to API Management service with version equal to or newer than this value.

minApiVersion String

Limit control plane API calls to API Management service with version equal to or newer than this value.

minApiVersion string

Limit control plane API calls to API Management service with version equal to or newer than this value.

min_api_version str

Limit control plane API calls to API Management service with version equal to or newer than this value.

minApiVersion String

Limit control plane API calls to API Management service with version equal to or newer than this value.

CertificateConfigurationResponse

StoreName string

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

Certificate Pulumi.AzureNative.ApiManagement.Inputs.CertificateInformationResponse

Certificate information.

CertificatePassword string

Certificate Password.

EncodedCertificate string

Base64 Encoded certificate.

StoreName string

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

Certificate CertificateInformationResponse

Certificate information.

CertificatePassword string

Certificate Password.

EncodedCertificate string

Base64 Encoded certificate.

storeName String

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate CertificateInformationResponse

Certificate information.

certificatePassword String

Certificate Password.

encodedCertificate String

Base64 Encoded certificate.

storeName string

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate CertificateInformationResponse

Certificate information.

certificatePassword string

Certificate Password.

encodedCertificate string

Base64 Encoded certificate.

store_name str

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate CertificateInformationResponse

Certificate information.

certificate_password str

Certificate Password.

encoded_certificate str

Base64 Encoded certificate.

storeName String

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate Property Map

Certificate information.

certificatePassword String

Certificate Password.

encodedCertificate String

Base64 Encoded certificate.

CertificateInformationResponse

Expiry string

Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Subject string

Subject of the certificate.

Thumbprint string

Thumbprint of the certificate.

Expiry string

Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Subject string

Subject of the certificate.

Thumbprint string

Thumbprint of the certificate.

expiry String

Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

subject String

Subject of the certificate.

thumbprint String

Thumbprint of the certificate.

expiry string

Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

subject string

Subject of the certificate.

thumbprint string

Thumbprint of the certificate.

expiry str

Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

subject str

Subject of the certificate.

thumbprint str

Thumbprint of the certificate.

expiry String

Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

subject String

Subject of the certificate.

thumbprint String

Thumbprint of the certificate.

HostnameConfigurationResponse

HostName string

Hostname to configure on the Api Management service.

Type string

Hostname type.

Certificate Pulumi.AzureNative.ApiManagement.Inputs.CertificateInformationResponse

Certificate information.

CertificatePassword string

Certificate Password.

DefaultSslBinding bool

Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.

EncodedCertificate string

Base64 Encoded certificate.

IdentityClientId string

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

KeyVaultId string

Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12

NegotiateClientCertificate bool

Specify true to always negotiate client certificate on the hostname. Default Value is false.

HostName string

Hostname to configure on the Api Management service.

Type string

Hostname type.

Certificate CertificateInformationResponse

Certificate information.

CertificatePassword string

Certificate Password.

DefaultSslBinding bool

Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.

EncodedCertificate string

Base64 Encoded certificate.

IdentityClientId string

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

KeyVaultId string

Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12

NegotiateClientCertificate bool

Specify true to always negotiate client certificate on the hostname. Default Value is false.

hostName String

Hostname to configure on the Api Management service.

type String

Hostname type.

certificate CertificateInformationResponse

Certificate information.

certificatePassword String

Certificate Password.

defaultSslBinding Boolean

Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.

encodedCertificate String

Base64 Encoded certificate.

identityClientId String

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

keyVaultId String

Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12

negotiateClientCertificate Boolean

Specify true to always negotiate client certificate on the hostname. Default Value is false.

hostName string

Hostname to configure on the Api Management service.

type string

Hostname type.

certificate CertificateInformationResponse

Certificate information.

certificatePassword string

Certificate Password.

defaultSslBinding boolean

Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.

encodedCertificate string

Base64 Encoded certificate.

identityClientId string

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

keyVaultId string

Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12

negotiateClientCertificate boolean

Specify true to always negotiate client certificate on the hostname. Default Value is false.

host_name str

Hostname to configure on the Api Management service.

type str

Hostname type.

certificate CertificateInformationResponse

Certificate information.

certificate_password str

Certificate Password.

default_ssl_binding bool

Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.

encoded_certificate str

Base64 Encoded certificate.

identity_client_id str

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

key_vault_id str

Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12

negotiate_client_certificate bool

Specify true to always negotiate client certificate on the hostname. Default Value is false.

hostName String

Hostname to configure on the Api Management service.

type String

Hostname type.

certificate Property Map

Certificate information.

certificatePassword String

Certificate Password.

defaultSslBinding Boolean

Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.

encodedCertificate String

Base64 Encoded certificate.

identityClientId String

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

keyVaultId String

Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12

negotiateClientCertificate Boolean

Specify true to always negotiate client certificate on the hostname. Default Value is false.

UserIdentityPropertiesResponse

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

clientId string

The client id of user assigned identity.

principalId string

The principal id of user assigned identity.

client_id str

The client id of user assigned identity.

principal_id str

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

VirtualNetworkConfigurationResponse

Subnetname string

The name of the subnet.

Vnetid string

The virtual network ID. This is typically a GUID. Expect a null GUID by default.

SubnetResourceId string

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

Subnetname string

The name of the subnet.

Vnetid string

The virtual network ID. This is typically a GUID. Expect a null GUID by default.

SubnetResourceId string

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

subnetname String

The name of the subnet.

vnetid String

The virtual network ID. This is typically a GUID. Expect a null GUID by default.

subnetResourceId String

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

subnetname string

The name of the subnet.

vnetid string

The virtual network ID. This is typically a GUID. Expect a null GUID by default.

subnetResourceId string

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

subnetname str

The name of the subnet.

vnetid str

The virtual network ID. This is typically a GUID. Expect a null GUID by default.

subnet_resource_id str

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

subnetname String

The name of the subnet.

vnetid String

The virtual network ID. This is typically a GUID. Expect a null GUID by default.

subnetResourceId String

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0