ArmApiManagementModelFactory.ApiManagementServiceData Method

Reference

Definition

Namespace:: Azure.ResourceManager.ApiManagement.Models

Assembly:: Azure.ResourceManager.ApiManagement.dll

Package:: Azure.ResourceManager.ApiManagement v1.3.0-beta.1

Source:: ArmApiManagementModelFactory.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Initializes a new instance of ApiManagementServiceData.

public static Azure.ResourceManager.ApiManagement.ApiManagementServiceData ApiManagementServiceData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, Azure.ResourceManager.ApiManagement.Models.ApiManagementServiceSkuProperties sku = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, Azure.ETag? etag = default, System.Collections.Generic.IEnumerable<string> zones = default, string notificationSenderEmail = default, string provisioningState = default, string targetProvisioningState = default, DateTimeOffset? createdAtUtc = default, Uri gatewayUri = default, Uri gatewayRegionalUri = default, Uri portalUri = default, Uri managementApiUri = default, Uri scmUri = default, Uri developerPortalUri = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.Models.HostnameConfiguration> hostnameConfigurations = default, System.Collections.Generic.IEnumerable<System.Net.IPAddress> publicIPAddresses = default, System.Collections.Generic.IEnumerable<System.Net.IPAddress> privateIPAddresses = default, Azure.Core.ResourceIdentifier publicIPAddressId = default, Azure.ResourceManager.ApiManagement.Models.PublicNetworkAccess? publicNetworkAccess = default, Azure.ResourceManager.ApiManagement.Models.LegacyApiState? legacyApi = default, Azure.ResourceManager.ApiManagement.Models.VirtualNetworkConfiguration virtualNetworkConfiguration = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.Models.AdditionalLocation> additionalLocations = default, System.Collections.Generic.IDictionary<string,string> customProperties = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.Models.CertificateConfiguration> certificates = default, bool? enableClientCertificate = default, Azure.ResourceManager.ApiManagement.Models.ApiManagementNatGatewayState? natGatewayState = default, System.Collections.Generic.IEnumerable<string> outboundPublicIPAddresses = default, bool? disableGateway = default, Azure.ResourceManager.ApiManagement.Models.VirtualNetworkType? virtualNetworkType = default, string minApiVersion = default, bool? restore = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.Models.RemotePrivateEndpointConnectionWrapper> privateEndpointConnections = default, Azure.ResourceManager.ApiManagement.Models.PlatformVersion? platformVersion = default, Azure.ResourceManager.ApiManagement.Models.LegacyPortalStatus? legacyPortalStatus = default, Azure.ResourceManager.ApiManagement.Models.DeveloperPortalStatus? developerPortalStatus = default, string publisherEmail = default, string publisherName = default);

static member ApiManagementServiceData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * Azure.ResourceManager.ApiManagement.Models.ApiManagementServiceSkuProperties * Azure.ResourceManager.Models.ManagedServiceIdentity * Nullable<Azure.ETag> * seq<string> * string * string * string * Nullable<DateTimeOffset> * Uri * Uri * Uri * Uri * Uri * Uri * seq<Azure.ResourceManager.ApiManagement.Models.HostnameConfiguration> * seq<System.Net.IPAddress> * seq<System.Net.IPAddress> * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.ApiManagement.Models.PublicNetworkAccess> * Nullable<Azure.ResourceManager.ApiManagement.Models.LegacyApiState> * Azure.ResourceManager.ApiManagement.Models.VirtualNetworkConfiguration * seq<Azure.ResourceManager.ApiManagement.Models.AdditionalLocation> * System.Collections.Generic.IDictionary<string, string> * seq<Azure.ResourceManager.ApiManagement.Models.CertificateConfiguration> * Nullable<bool> * Nullable<Azure.ResourceManager.ApiManagement.Models.ApiManagementNatGatewayState> * seq<string> * Nullable<bool> * Nullable<Azure.ResourceManager.ApiManagement.Models.VirtualNetworkType> * string * Nullable<bool> * seq<Azure.ResourceManager.ApiManagement.Models.RemotePrivateEndpointConnectionWrapper> * Nullable<Azure.ResourceManager.ApiManagement.Models.PlatformVersion> * Nullable<Azure.ResourceManager.ApiManagement.Models.LegacyPortalStatus> * Nullable<Azure.ResourceManager.ApiManagement.Models.DeveloperPortalStatus> * string * string -> Azure.ResourceManager.ApiManagement.ApiManagementServiceData

Public Shared Function ApiManagementServiceData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional sku As ApiManagementServiceSkuProperties = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional etag As Nullable(Of ETag) = Nothing, Optional zones As IEnumerable(Of String) = Nothing, Optional notificationSenderEmail As String = Nothing, Optional provisioningState As String = Nothing, Optional targetProvisioningState As String = Nothing, Optional createdAtUtc As Nullable(Of DateTimeOffset) = Nothing, Optional gatewayUri As Uri = Nothing, Optional gatewayRegionalUri As Uri = Nothing, Optional portalUri As Uri = Nothing, Optional managementApiUri As Uri = Nothing, Optional scmUri As Uri = Nothing, Optional developerPortalUri As Uri = Nothing, Optional hostnameConfigurations As IEnumerable(Of HostnameConfiguration) = Nothing, Optional publicIPAddresses As IEnumerable(Of IPAddress) = Nothing, Optional privateIPAddresses As IEnumerable(Of IPAddress) = Nothing, Optional publicIPAddressId As ResourceIdentifier = Nothing, Optional publicNetworkAccess As Nullable(Of PublicNetworkAccess) = Nothing, Optional legacyApi As Nullable(Of LegacyApiState) = Nothing, Optional virtualNetworkConfiguration As VirtualNetworkConfiguration = Nothing, Optional additionalLocations As IEnumerable(Of AdditionalLocation) = Nothing, Optional customProperties As IDictionary(Of String, String) = Nothing, Optional certificates As IEnumerable(Of CertificateConfiguration) = Nothing, Optional enableClientCertificate As Nullable(Of Boolean) = Nothing, Optional natGatewayState As Nullable(Of ApiManagementNatGatewayState) = Nothing, Optional outboundPublicIPAddresses As IEnumerable(Of String) = Nothing, Optional disableGateway As Nullable(Of Boolean) = Nothing, Optional virtualNetworkType As Nullable(Of VirtualNetworkType) = Nothing, Optional minApiVersion As String = Nothing, Optional restore As Nullable(Of Boolean) = Nothing, Optional privateEndpointConnections As IEnumerable(Of RemotePrivateEndpointConnectionWrapper) = Nothing, Optional platformVersion As Nullable(Of PlatformVersion) = Nothing, Optional legacyPortalStatus As Nullable(Of LegacyPortalStatus) = Nothing, Optional developerPortalStatus As Nullable(Of DeveloperPortalStatus) = Nothing, Optional publisherEmail As String = Nothing, Optional publisherName As String = Nothing) As ApiManagementServiceData

Parameters

id: ResourceIdentifier

The id.

name: String

The name.

resourceType: ResourceType

The resourceType.

systemData: SystemData

The systemData.

tags: IDictionary<String,String>

The tags.

location: AzureLocation

The location.

sku: ApiManagementServiceSkuProperties

SKU properties of the API Management service.

identity: ManagedServiceIdentity

Managed service identity of the Api Management service.

etag: Nullable<ETag>

ETag of the resource.

zones: IEnumerable<String>

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

notificationSenderEmail: String

Email address from which the notification will be sent.

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.

targetProvisioningState: String

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

createdAtUtc: Nullable<DateTimeOffset>

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.

gatewayUri: Uri

Gateway URL of the API Management service.

gatewayRegionalUri: Uri

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

portalUri: Uri

Publisher portal endpoint Url of the API Management service.

managementApiUri: Uri

Management API endpoint URL of the API Management service.

scmUri: Uri

SCM endpoint URL of the API Management service.

developerPortalUri: Uri

DEveloper Portal endpoint URL of the API Management service.

hostnameConfigurations: IEnumerable<HostnameConfiguration>

Custom hostname configuration of the API Management service.

publicIPAddresses: IEnumerable<IPAddress>

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

privateIPAddresses: IEnumerable<IPAddress>

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.

publicIPAddressId: ResourceIdentifier

Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.

publicNetworkAccess: Nullable<PublicNetworkAccess>

Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'.

legacyApi: Nullable<LegacyApiState>

Configuration API configuration of the API Management service.

virtualNetworkConfiguration: VirtualNetworkConfiguration

Virtual network configuration of the API Management service.

additionalLocations: IEnumerable<AdditionalLocation>

Additional datacenter locations of the API Management service.

customProperties: IDictionary<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 1, 2018 and False otherwise. Http2 setting's default value is False.You can disable any of the following 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: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,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.

certificates: IEnumerable<CertificateConfiguration>

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

enableClientCertificate: Nullable<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.

natGatewayState: Nullable<ApiManagementNatGatewayState>

Property can be used to enable NAT Gateway for this API Management service.

outboundPublicIPAddresses: IEnumerable<String>

Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.

disableGateway: Nullable<Boolean>

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

virtualNetworkType: Nullable<VirtualNetworkType>

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.