ApiManagementServiceResource Constructors
Definition
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.
Overloads
ApiManagementServiceResource()
Initializes a new instance of the ApiManagementServiceResource class.
public ApiManagementServiceResource ();Public Sub New ()Applies to
ApiManagementServiceResource(String, String, ApiManagementServiceSkuProperties, String, String, String, String, IDictionary<String,String>, String, String, String, Nullable<DateTime>, String, String, String, String, String, String, IList<HostnameConfiguration>, IList<String>, IList<String>, String, String, VirtualNetworkConfiguration, IList<AdditionalLocation>, IDictionary<String,String>, IList<CertificateConfiguration>, Nullable<Boolean>, Nullable<Boolean>, String, ApiVersionConstraint, Nullable<Boolean>, IList<RemotePrivateEndpointConnectionWrapper>, String, ApiManagementServiceIdentity, SystemData, String, IList<String>)
Initializes a new instance of the ApiManagementServiceResource class.
public ApiManagementServiceResource (string publisherEmail, string publisherName, Microsoft.Azure.Management.ApiManagement.Models.ApiManagementServiceSkuProperties sku, string location, string id = default, string name = default, string type = default, System.Collections.Generic.IDictionary<string,string> tags = default, string notificationSenderEmail = default, string provisioningState = default, string targetProvisioningState = default, DateTime? createdAtUtc = default, string gatewayUrl = default, string gatewayRegionalUrl = default, string portalUrl = default, string managementApiUrl = default, string scmUrl = default, string developerPortalUrl = default, System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.HostnameConfiguration> hostnameConfigurations = default, System.Collections.Generic.IList<string> publicIPAddresses = default, System.Collections.Generic.IList<string> privateIPAddresses = default, string publicIpAddressId = default, string publicNetworkAccess = default, Microsoft.Azure.Management.ApiManagement.Models.VirtualNetworkConfiguration virtualNetworkConfiguration = default, System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.AdditionalLocation> additionalLocations = default, System.Collections.Generic.IDictionary<string,string> customProperties = default, System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.CertificateConfiguration> certificates = default, bool? enableClientCertificate = default, bool? disableGateway = default, string virtualNetworkType = default, Microsoft.Azure.Management.ApiManagement.Models.ApiVersionConstraint apiVersionConstraint = default, bool? restore = default, System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.RemotePrivateEndpointConnectionWrapper> privateEndpointConnections = default, string platformVersion = default, Microsoft.Azure.Management.ApiManagement.Models.ApiManagementServiceIdentity identity = default, Microsoft.Azure.Management.ApiManagement.Models.SystemData systemData = default, string etag = default, System.Collections.Generic.IList<string> zones = default);new Microsoft.Azure.Management.ApiManagement.Models.ApiManagementServiceResource : string * string * Microsoft.Azure.Management.ApiManagement.Models.ApiManagementServiceSkuProperties * string * string * string * string * System.Collections.Generic.IDictionary<string, string> * string * string * string * Nullable<DateTime> * string * string * string * string * string * string * System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.HostnameConfiguration> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * string * string * Microsoft.Azure.Management.ApiManagement.Models.VirtualNetworkConfiguration * System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.AdditionalLocation> * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.CertificateConfiguration> * Nullable<bool> * Nullable<bool> * string * Microsoft.Azure.Management.ApiManagement.Models.ApiVersionConstraint * Nullable<bool> * System.Collections.Generic.IList<Microsoft.Azure.Management.ApiManagement.Models.RemotePrivateEndpointConnectionWrapper> * string * Microsoft.Azure.Management.ApiManagement.Models.ApiManagementServiceIdentity * Microsoft.Azure.Management.ApiManagement.Models.SystemData * string * System.Collections.Generic.IList<string> -> Microsoft.Azure.Management.ApiManagement.Models.ApiManagementServiceResourcePublic Sub New (publisherEmail As String, publisherName As String, sku As ApiManagementServiceSkuProperties, location As String, Optional id As String = Nothing, Optional name As String = Nothing, Optional type As String = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional notificationSenderEmail As String = Nothing, Optional provisioningState As String = Nothing, Optional targetProvisioningState As String = Nothing, Optional createdAtUtc As Nullable(Of DateTime) = Nothing, Optional gatewayUrl As String = Nothing, Optional gatewayRegionalUrl As String = Nothing, Optional portalUrl As String = Nothing, Optional managementApiUrl As String = Nothing, Optional scmUrl As String = Nothing, Optional developerPortalUrl As String = Nothing, Optional hostnameConfigurations As IList(Of HostnameConfiguration) = Nothing, Optional publicIPAddresses As IList(Of String) = Nothing, Optional privateIPAddresses As IList(Of String) = Nothing, Optional publicIpAddressId As String = Nothing, Optional publicNetworkAccess As String = Nothing, Optional virtualNetworkConfiguration As VirtualNetworkConfiguration = Nothing, Optional additionalLocations As IList(Of AdditionalLocation) = Nothing, Optional customProperties As IDictionary(Of String, String) = Nothing, Optional certificates As IList(Of CertificateConfiguration) = Nothing, Optional enableClientCertificate As Nullable(Of Boolean) = Nothing, Optional disableGateway As Nullable(Of Boolean) = Nothing, Optional virtualNetworkType As String = Nothing, Optional apiVersionConstraint As ApiVersionConstraint = Nothing, Optional restore As Nullable(Of Boolean) = Nothing, Optional privateEndpointConnections As IList(Of RemotePrivateEndpointConnectionWrapper) = Nothing, Optional platformVersion As String = Nothing, Optional identity As ApiManagementServiceIdentity = Nothing, Optional systemData As SystemData = Nothing, Optional etag As String = Nothing, Optional zones As IList(Of String) = Nothing)Parameters
- publisherEmail
- String
Publisher email.
- publisherName
- String
Publisher name.
SKU properties of the API Management service.
- location
- String
Resource location.
- id
- String
Resource ID.
- name
- String
Resource name.
- type
- String
Resource type for API Management resource is set to Microsoft.ApiManagement.
- tags
- IDictionary<String,String>
Resource tags.
- 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.
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.
- gatewayUrl
- String
Gateway URL of the API Management service.
- gatewayRegionalUrl
- String
Gateway URL of the API Management service in the Default Region.
- portalUrl
- String
Publisher portal endpoint Url of the API Management service.
- managementApiUrl
- String
Management API endpoint URL of the API Management service.
- scmUrl
- String
SCM endpoint URL of the API Management service.
- developerPortalUrl
- String
DEveloper Portal endpoint URL of the API Management service.
- hostnameConfigurations
- IList<HostnameConfiguration>
Custom hostname configuration of the API Management service.
Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
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
- String
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
- String
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'. Possible values include: 'Enabled', 'Disabled'
- virtualNetworkConfiguration
- VirtualNetworkConfiguration
Virtual network configuration of the API Management service.
- additionalLocations
- IList<AdditionalLocation>
Additional datacenter locations of the API Management service.
- customProperties
- IDictionary<String,String>
Custom properties of the API
Management service.</br>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).</br>Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11
can be used to disable just TLS 1.1.</br>Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10
can be used to disable TLS 1.0 on an API Management
service.</br>Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11
can be used to disable just TLS 1.1 for communications with
backends.</br>Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10
can be used to disable TLS 1.0 for communications with
backends.</br>Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2
can be used to enable HTTP2 protocol on an API Management
service.</br>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.</br></br>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
- certificates
- IList<CertificateConfiguration>
List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
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.
Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
- 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. Possible values include: 'None', 'External', 'Internal'
- apiVersionConstraint
- ApiVersionConstraint
Control Plane Apis version constraint for the API Management service.
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.
- privateEndpointConnections
- IList<RemotePrivateEndpointConnectionWrapper>
List of Private Endpoint Connections of this service.
- platformVersion
- String
Compute Platform Version running the service in this location. Possible values include: 'undetermined', 'stv1', 'stv2', 'mtv1'
- identity
- ApiManagementServiceIdentity
Managed service identity of the Api Management service.
- systemData
- SystemData
Metadata pertaining to creation and last modification of the resource.
- etag
- String
ETag of the resource.
Applies to
Azure SDK for .NET