azure-docs-sdk-java/legacy/docs-ref-autogen/com.microsoft.azure.managem...

445 строки
49 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters"
name: "ApiManagementServiceUpdateParameters"
nameWithType: "ApiManagementServiceUpdateParameters"
summary: "Parameter supplied to Update Api Management Service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.ProxyResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApimResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.azure.ProxyResource?alt=com.microsoft.azure.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.ProxyResource.id()?alt=com.microsoft.azure.ProxyResource.id&text=id\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.ProxyResource.name()?alt=com.microsoft.azure.ProxyResource.name&text=name\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.ProxyResource.type()?alt=com.microsoft.azure.ProxyResource.type&text=type\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApimResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApimResource&text=ApimResource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApimResource.tags()?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApimResource.tags&text=tags\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApimResource.withTags(java.util.Map<java.lang.String,java.lang.String>)?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApimResource.withTags&text=withTags\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **ApiManagementServiceUpdateParameters**</br> extends <xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApimResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApimResource&text=ApimResource\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.ApiManagementServiceUpdateParameters()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.ApiManagementServiceUpdateParameters()"
name: "ApiManagementServiceUpdateParameters()"
nameWithType: "ApiManagementServiceUpdateParameters.ApiManagementServiceUpdateParameters()"
syntax: "public ApiManagementServiceUpdateParameters()"
methods:
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.additionalLocations()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.additionalLocations()"
name: "additionalLocations()"
nameWithType: "ApiManagementServiceUpdateParameters.additionalLocations()"
summary: "Get additional datacenter locations of the API Management service."
syntax: "public List<AdditionalLocation> additionalLocations()"
desc: "Get additional datacenter locations of the API Management service."
returns:
description: "the additionalLocations value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AdditionalLocation?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AdditionalLocation&text=AdditionalLocation\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.certificates()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.certificates()"
name: "certificates()"
nameWithType: "ApiManagementServiceUpdateParameters.certificates()"
summary: "Get list of Certificates that need to be installed in the API Management service."
syntax: "public List<CertificateConfiguration> certificates()"
desc: "Get list of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10."
returns:
description: "the certificates value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.CertificateConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.CertificateConfiguration&text=CertificateConfiguration\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.createdAtUtc()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.createdAtUtc()"
name: "createdAtUtc()"
nameWithType: "ApiManagementServiceUpdateParameters.createdAtUtc()"
summary: "Get creation UTC date of the API Management service.<wbr>The date conforms to the following format: \\`yyyy-MM-ddTHH:mm:ssZ\\` as specified by the ISO 8601 standard."
syntax: "public DateTime createdAtUtc()"
desc: "Get 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."
returns:
description: "the createdAtUtc value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.customProperties()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.customProperties()"
name: "customProperties()"
nameWithType: "ApiManagementServiceUpdateParameters.customProperties()"
summary: "Get custom properties of the API Management service.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Ciphers.<wbr>Triple<wbr>Des168\\` will disable the cipher TLS\\_RSA\\_WITH\\_3DES\\_EDE\\_CBC\\_SHA for all TLS(1.0, 1.1 and 1.2).</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Protocols.<wbr>Tls11\\` can be used to disable just TLS 1.1.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Protocols.<wbr>Tls10\\` can be used to disable TLS 1.0 on an API Management service.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Backend.<wbr>Protocols.<wbr>Tls11\\` can be used to disable just TLS 1.1 for communications with backends.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Backend.<wbr>Protocols.<wbr>Tls10\\` can be used to disable TLS 1.0 for communications with backends.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Protocols.<wbr>Server.<wbr>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."
syntax: "public Map<String,String> customProperties()"
desc: "Get 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."
returns:
description: "the customProperties value"
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.enableClientCertificate()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.enableClientCertificate()"
name: "enableClientCertificate()"
nameWithType: "ApiManagementServiceUpdateParameters.enableClientCertificate()"
summary: "Get property only meant to be used for Consumption SKU Service."
syntax: "public Boolean enableClientCertificate()"
desc: "Get 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."
returns:
description: "the enableClientCertificate value"
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.etag()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.etag()"
name: "etag()"
nameWithType: "ApiManagementServiceUpdateParameters.etag()"
summary: "Get e<wbr>Tag of the resource."
syntax: "public String etag()"
desc: "Get eTag of the resource."
returns:
description: "the etag value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.gatewayRegionalUrl()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.gatewayRegionalUrl()"
name: "gatewayRegionalUrl()"
nameWithType: "ApiManagementServiceUpdateParameters.gatewayRegionalUrl()"
summary: "Get gateway URL of the API Management service in the Default Region."
syntax: "public String gatewayRegionalUrl()"
desc: "Get gateway URL of the API Management service in the Default Region."
returns:
description: "the gatewayRegionalUrl value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.gatewayUrl()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.gatewayUrl()"
name: "gatewayUrl()"
nameWithType: "ApiManagementServiceUpdateParameters.gatewayUrl()"
summary: "Get gateway URL of the API Management service."
syntax: "public String gatewayUrl()"
desc: "Get gateway URL of the API Management service."
returns:
description: "the gatewayUrl value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.hostnameConfigurations()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.hostnameConfigurations()"
name: "hostnameConfigurations()"
nameWithType: "ApiManagementServiceUpdateParameters.hostnameConfigurations()"
summary: "Get custom hostname configuration of the API Management service."
syntax: "public List<HostnameConfiguration> hostnameConfigurations()"
desc: "Get custom hostname configuration of the API Management service."
returns:
description: "the hostnameConfigurations value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.identity()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.identity()"
name: "identity()"
nameWithType: "ApiManagementServiceUpdateParameters.identity()"
summary: "Get managed service identity of the Api Management service."
syntax: "public ApiManagementServiceIdentity identity()"
desc: "Get managed service identity of the Api Management service."
returns:
description: "the identity value"
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceIdentity?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceIdentity&text=ApiManagementServiceIdentity\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.managementApiUrl()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.managementApiUrl()"
name: "managementApiUrl()"
nameWithType: "ApiManagementServiceUpdateParameters.managementApiUrl()"
summary: "Get management API endpoint URL of the API Management service."
syntax: "public String managementApiUrl()"
desc: "Get management API endpoint URL of the API Management service."
returns:
description: "the managementApiUrl value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.notificationSenderEmail()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.notificationSenderEmail()"
name: "notificationSenderEmail()"
nameWithType: "ApiManagementServiceUpdateParameters.notificationSenderEmail()"
summary: "Get email address from which the notification will be sent."
syntax: "public String notificationSenderEmail()"
desc: "Get email address from which the notification will be sent."
returns:
description: "the notificationSenderEmail value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.portalUrl()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.portalUrl()"
name: "portalUrl()"
nameWithType: "ApiManagementServiceUpdateParameters.portalUrl()"
summary: "Get publisher portal endpoint Url of the API Management service."
syntax: "public String portalUrl()"
desc: "Get publisher portal endpoint Url of the API Management service."
returns:
description: "the portalUrl value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.privateIPAddresses()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.privateIPAddresses()"
name: "privateIPAddresses()"
nameWithType: "ApiManagementServiceUpdateParameters.privateIPAddresses()"
summary: "Get private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network."
syntax: "public List<String> privateIPAddresses()"
desc: "Get 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 and Premium SKU."
returns:
description: "the privateIPAddresses value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.provisioningState()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.provisioningState()"
name: "provisioningState()"
nameWithType: "ApiManagementServiceUpdateParameters.provisioningState()"
summary: "Get the current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/Termination<wbr>Failed/Deleted."
syntax: "public String provisioningState()"
desc: "Get 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."
returns:
description: "the provisioningState value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.publicIPAddresses()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.publicIPAddresses()"
name: "publicIPAddresses()"
nameWithType: "ApiManagementServiceUpdateParameters.publicIPAddresses()"
summary: "Get public Static Load Balanced IP addresses of the API Management service in Primary region."
syntax: "public List<String> publicIPAddresses()"
desc: "Get public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU."
returns:
description: "the publicIPAddresses value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.publisherEmail()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.publisherEmail()"
name: "publisherEmail()"
nameWithType: "ApiManagementServiceUpdateParameters.publisherEmail()"
summary: "Get publisher email."
syntax: "public String publisherEmail()"
desc: "Get publisher email."
returns:
description: "the publisherEmail value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.publisherName()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.publisherName()"
name: "publisherName()"
nameWithType: "ApiManagementServiceUpdateParameters.publisherName()"
summary: "Get publisher name."
syntax: "public String publisherName()"
desc: "Get publisher name."
returns:
description: "the publisherName value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.scmUrl()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.scmUrl()"
name: "scmUrl()"
nameWithType: "ApiManagementServiceUpdateParameters.scmUrl()"
summary: "Get sCM endpoint URL of the API Management service."
syntax: "public String scmUrl()"
desc: "Get sCM endpoint URL of the API Management service."
returns:
description: "the scmUrl value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.sku()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.sku()"
name: "sku()"
nameWithType: "ApiManagementServiceUpdateParameters.sku()"
summary: "Get sKU properties of the API Management service."
syntax: "public ApiManagementServiceSkuProperties sku()"
desc: "Get sKU properties of the API Management service."
returns:
description: "the sku value"
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceSkuProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceSkuProperties&text=ApiManagementServiceSkuProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.targetProvisioningState()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.targetProvisioningState()"
name: "targetProvisioningState()"
nameWithType: "ApiManagementServiceUpdateParameters.targetProvisioningState()"
summary: "Get the provisioning state of the API Management service, which is targeted by the long running operation started on the service."
syntax: "public String targetProvisioningState()"
desc: "Get the provisioning state of the API Management service, which is targeted by the long running operation started on the service."
returns:
description: "the targetProvisioningState value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.virtualNetworkConfiguration()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.virtualNetworkConfiguration()"
name: "virtualNetworkConfiguration()"
nameWithType: "ApiManagementServiceUpdateParameters.virtualNetworkConfiguration()"
summary: "Get virtual network configuration of the API Management service."
syntax: "public VirtualNetworkConfiguration virtualNetworkConfiguration()"
desc: "Get virtual network configuration of the API Management service."
returns:
description: "the virtualNetworkConfiguration value"
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.VirtualNetworkConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.VirtualNetworkConfiguration&text=VirtualNetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.virtualNetworkType()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.virtualNetworkType()"
name: "virtualNetworkType()"
nameWithType: "ApiManagementServiceUpdateParameters.virtualNetworkType()"
summary: "Get the type of VPN in which API Management service needs to be configured in."
syntax: "public VirtualNetworkType virtualNetworkType()"
desc: "Get 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'."
returns:
description: "the virtualNetworkType value"
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.VirtualNetworkType?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.VirtualNetworkType&text=VirtualNetworkType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withAdditionalLocations(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.AdditionalLocation>)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withAdditionalLocations(List<AdditionalLocation> additionalLocations)"
name: "withAdditionalLocations(List<AdditionalLocation> additionalLocations)"
nameWithType: "ApiManagementServiceUpdateParameters.withAdditionalLocations(List<AdditionalLocation> additionalLocations)"
summary: "Set additional datacenter locations of the API Management service."
parameters:
- description: "the additionalLocations value to set"
name: "additionalLocations"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AdditionalLocation?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AdditionalLocation&text=AdditionalLocation\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public ApiManagementServiceUpdateParameters withAdditionalLocations(List<AdditionalLocation> additionalLocations)"
desc: "Set additional datacenter locations of the API Management service."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withCertificates(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.CertificateConfiguration>)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withCertificates(List<CertificateConfiguration> certificates)"
name: "withCertificates(List<CertificateConfiguration> certificates)"
nameWithType: "ApiManagementServiceUpdateParameters.withCertificates(List<CertificateConfiguration> certificates)"
summary: "Set list of Certificates that need to be installed in the API Management service."
parameters:
- description: "the certificates value to set"
name: "certificates"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.CertificateConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.CertificateConfiguration&text=CertificateConfiguration\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public ApiManagementServiceUpdateParameters withCertificates(List<CertificateConfiguration> certificates)"
desc: "Set list of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withCustomProperties(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withCustomProperties(Map<String,String> customProperties)"
name: "withCustomProperties(Map<String,String> customProperties)"
nameWithType: "ApiManagementServiceUpdateParameters.withCustomProperties(Map<String,String> customProperties)"
summary: "Set custom properties of the API Management service.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Ciphers.<wbr>Triple<wbr>Des168\\` will disable the cipher TLS\\_RSA\\_WITH\\_3DES\\_EDE\\_CBC\\_SHA for all TLS(1.0, 1.1 and 1.2).</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Protocols.<wbr>Tls11\\` can be used to disable just TLS 1.1.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Protocols.<wbr>Tls10\\` can be used to disable TLS 1.0 on an API Management service.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Backend.<wbr>Protocols.<wbr>Tls11\\` can be used to disable just TLS 1.1 for communications with backends.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Security.<wbr>Backend.<wbr>Protocols.<wbr>Tls10\\` can be used to disable TLS 1.0 for communications with backends.</br>Setting \\`Microsoft.<wbr>Windows<wbr>Azure.<wbr>Api<wbr>Management.<wbr>Gateway.<wbr>Protocols.<wbr>Server.<wbr>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."
parameters:
- description: "the customProperties value to set"
name: "customProperties"
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public ApiManagementServiceUpdateParameters withCustomProperties(Map<String,String> customProperties)"
desc: "Set 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."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withEnableClientCertificate(java.lang.Boolean)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withEnableClientCertificate(Boolean enableClientCertificate)"
name: "withEnableClientCertificate(Boolean enableClientCertificate)"
nameWithType: "ApiManagementServiceUpdateParameters.withEnableClientCertificate(Boolean enableClientCertificate)"
summary: "Set property only meant to be used for Consumption SKU Service."
parameters:
- description: "the enableClientCertificate value to set"
name: "enableClientCertificate"
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiManagementServiceUpdateParameters withEnableClientCertificate(Boolean enableClientCertificate)"
desc: "Set 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."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withHostnameConfigurations(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration>)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations)"
name: "withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations)"
nameWithType: "ApiManagementServiceUpdateParameters.withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations)"
summary: "Set custom hostname configuration of the API Management service."
parameters:
- description: "the hostnameConfigurations value to set"
name: "hostnameConfigurations"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.HostnameConfiguration&text=HostnameConfiguration\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public ApiManagementServiceUpdateParameters withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations)"
desc: "Set custom hostname configuration of the API Management service."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withIdentity(com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceIdentity)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withIdentity(ApiManagementServiceIdentity identity)"
name: "withIdentity(ApiManagementServiceIdentity identity)"
nameWithType: "ApiManagementServiceUpdateParameters.withIdentity(ApiManagementServiceIdentity identity)"
summary: "Set managed service identity of the Api Management service."
parameters:
- description: "the identity value to set"
name: "identity"
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceIdentity?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceIdentity&text=ApiManagementServiceIdentity\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiManagementServiceUpdateParameters withIdentity(ApiManagementServiceIdentity identity)"
desc: "Set managed service identity of the Api Management service."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withNotificationSenderEmail(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withNotificationSenderEmail(String notificationSenderEmail)"
name: "withNotificationSenderEmail(String notificationSenderEmail)"
nameWithType: "ApiManagementServiceUpdateParameters.withNotificationSenderEmail(String notificationSenderEmail)"
summary: "Set email address from which the notification will be sent."
parameters:
- description: "the notificationSenderEmail value to set"
name: "notificationSenderEmail"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiManagementServiceUpdateParameters withNotificationSenderEmail(String notificationSenderEmail)"
desc: "Set email address from which the notification will be sent."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withPublisherEmail(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withPublisherEmail(String publisherEmail)"
name: "withPublisherEmail(String publisherEmail)"
nameWithType: "ApiManagementServiceUpdateParameters.withPublisherEmail(String publisherEmail)"
summary: "Set publisher email."
parameters:
- description: "the publisherEmail value to set"
name: "publisherEmail"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiManagementServiceUpdateParameters withPublisherEmail(String publisherEmail)"
desc: "Set publisher email."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withPublisherName(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withPublisherName(String publisherName)"
name: "withPublisherName(String publisherName)"
nameWithType: "ApiManagementServiceUpdateParameters.withPublisherName(String publisherName)"
summary: "Set publisher name."
parameters:
- description: "the publisherName value to set"
name: "publisherName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiManagementServiceUpdateParameters withPublisherName(String publisherName)"
desc: "Set publisher name."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withSku(com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceSkuProperties)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withSku(ApiManagementServiceSkuProperties sku)"
name: "withSku(ApiManagementServiceSkuProperties sku)"
nameWithType: "ApiManagementServiceUpdateParameters.withSku(ApiManagementServiceSkuProperties sku)"
summary: "Set sKU properties of the API Management service."
parameters:
- description: "the sku value to set"
name: "sku"
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceSkuProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceSkuProperties&text=ApiManagementServiceSkuProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiManagementServiceUpdateParameters withSku(ApiManagementServiceSkuProperties sku)"
desc: "Set sKU properties of the API Management service."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withVirtualNetworkConfiguration(com.microsoft.azure.management.apimanagement.v2019_01_01.VirtualNetworkConfiguration)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration)"
name: "withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration)"
nameWithType: "ApiManagementServiceUpdateParameters.withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration)"
summary: "Set virtual network configuration of the API Management service."
parameters:
- description: "the virtualNetworkConfiguration value to set"
name: "virtualNetworkConfiguration"
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.VirtualNetworkConfiguration?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.VirtualNetworkConfiguration&text=VirtualNetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiManagementServiceUpdateParameters withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration)"
desc: "Set virtual network configuration of the API Management service."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withVirtualNetworkType(com.microsoft.azure.management.apimanagement.v2019_01_01.VirtualNetworkType)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters.withVirtualNetworkType(VirtualNetworkType virtualNetworkType)"
name: "withVirtualNetworkType(VirtualNetworkType virtualNetworkType)"
nameWithType: "ApiManagementServiceUpdateParameters.withVirtualNetworkType(VirtualNetworkType virtualNetworkType)"
summary: "Set the type of VPN in which API Management service needs to be configured in."
parameters:
- description: "the virtualNetworkType value to set"
name: "virtualNetworkType"
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.VirtualNetworkType?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.VirtualNetworkType&text=VirtualNetworkType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiManagementServiceUpdateParameters withVirtualNetworkType(VirtualNetworkType virtualNetworkType)"
desc: "Set 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'."
returns:
description: "the ApiManagementServiceUpdateParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Parameter supplied to Update Api Management Service."
metadata: {}
package: "com.microsoft.azure.management.apimanagement.v2019_01_01"
artifact: com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1