Api Management Service - Update

Updates an existing API Management service.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?api-version=2019-01-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

api-version
query True
  • string

Version of the API to be used with the client request.

Request Body

Name Type Description
identity

Managed service identity of the Api Management service.

properties.additionalLocations

Additional datacenter locations of the API Management service.

properties.certificates

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

properties.customProperties
  • object

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 and setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.

properties.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.

properties.hostnameConfigurations

Custom hostname configuration of the API Management service.

properties.notificationSenderEmail
  • string

Email address from which the notification will be sent.

properties.publisherEmail
  • string

Publisher email.

properties.publisherName
  • string

Publisher name.

properties.virtualNetworkConfiguration

Virtual network configuration of the API Management service.

properties.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.

sku

SKU properties of the API Management service.

tags
  • object

Resource tags.

Responses

Name Type Description
200 OK

The service was successfully updated.

202 Accepted

The service update request was Accepted.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementUpdateServiceDisableTls10
ApiManagementUpdateServicePublisherDetails

ApiManagementUpdateServiceDisableTls10

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2019-01-01
{
  "properties": {
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"
    }
  }
}

Sample Response

ApiManagementUpdateServicePublisherDetails

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2019-01-01
{
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext"
  }
}

Sample Response

Definitions

AdditionalLocation

Description of an additional API Management resource location.

ApiManagementServiceIdentity

Identity properties of the Api Management service resource.

ApiManagementServiceResource

A single API Management service resource in List or Get response.

ApiManagementServiceSkuProperties

API Management service resource SKU properties.

ApiManagementServiceUpdateParameters

Parameter supplied to Update Api Management Service.

ApimIdentityType

The identity type. Currently the only supported type is 'SystemAssigned'.

CertificateConfiguration

Certificate configuration which consist of non-trusted intermediates and root certificates.

CertificateInformation

SSL certificate information.

HostnameConfiguration

Custom hostname configuration.

HostnameType

Hostname type.

SkuType

Name of the Sku.

VirtualNetworkConfiguration

Configuration of a virtual network to which API Management service is deployed.

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.

AdditionalLocation

Description of an additional API Management resource location.

Name Type Description
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 and Premium SKU.

publicIPAddresses
  • string[]

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

sku

SKU properties of the API Management service.

virtualNetworkConfiguration

Virtual network configuration for the location.

ApiManagementServiceIdentity

Identity properties of the Api Management service resource.

Name Type Description
principalId
  • string

The principal id of the identity.

tenantId
  • string

The client tenant id of the identity.

type

The identity type. Currently the only supported type is 'SystemAssigned'.

ApiManagementServiceResource

A single API Management service resource in List or Get response.

Name Type Description
etag
  • string

ETag of the resource.

id
  • string

Resource ID.

identity

Managed service identity of the Api Management service.

location
  • string

Resource location.

name
  • string

Resource name.

properties.additionalLocations

Additional datacenter locations of the API Management service.

properties.certificates

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

properties.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.

properties.customProperties
  • object

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 and setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.

properties.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.

properties.gatewayRegionalUrl
  • string

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

properties.gatewayUrl
  • string

Gateway URL of the API Management service.

properties.hostnameConfigurations

Custom hostname configuration of the API Management service.

properties.managementApiUrl
  • string

Management API endpoint URL of the API Management service.

properties.notificationSenderEmail
  • string

Email address from which the notification will be sent.

properties.portalUrl
  • string

Publisher portal endpoint Url of the API Management service.

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

properties.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.

properties.publicIPAddresses
  • string[]

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

properties.publisherEmail
  • string

Publisher email.

properties.publisherName
  • string

Publisher name.

properties.scmUrl
  • string

SCM endpoint URL of the API Management service.

properties.targetProvisioningState
  • string

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

properties.virtualNetworkConfiguration

Virtual network configuration of the API Management service.

properties.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.

sku

SKU properties of the API Management service.

tags
  • object

Resource tags.

type
  • string

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

ApiManagementServiceSkuProperties

API Management service resource SKU properties.

Name Type Description
capacity
  • integer

Capacity of the SKU (number of deployed units of the SKU). The default value is 1.

name

Name of the Sku.

ApiManagementServiceUpdateParameters

Parameter supplied to Update Api Management Service.

Name Type Description
etag
  • string

ETag of the resource.

id
  • string

Resource ID.

identity

Managed service identity of the Api Management service.

name
  • string

Resource name.

properties.additionalLocations

Additional datacenter locations of the API Management service.

properties.certificates

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

properties.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.

properties.customProperties
  • object

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 and setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.

properties.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.

properties.gatewayRegionalUrl
  • string

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

properties.gatewayUrl
  • string

Gateway URL of the API Management service.

properties.hostnameConfigurations

Custom hostname configuration of the API Management service.

properties.managementApiUrl
  • string

Management API endpoint URL of the API Management service.

properties.notificationSenderEmail
  • string

Email address from which the notification will be sent.

properties.portalUrl
  • string

Publisher portal endpoint Url of the API Management service.

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

properties.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.

properties.publicIPAddresses
  • string[]

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

properties.publisherEmail
  • string

Publisher email.

properties.publisherName
  • string

Publisher name.

properties.scmUrl
  • string

SCM endpoint URL of the API Management service.

properties.targetProvisioningState
  • string

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

properties.virtualNetworkConfiguration

Virtual network configuration of the API Management service.

properties.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.

sku

SKU properties of the API Management service.

tags
  • object

Resource tags.

type
  • string

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

ApimIdentityType

The identity type. Currently the only supported type is 'SystemAssigned'.

Name Type Description
SystemAssigned
  • string

CertificateConfiguration

Certificate configuration which consist of non-trusted intermediates and root certificates.

Name Type Description
certificate

Certificate information.

certificatePassword
  • string

Certificate Password.

encodedCertificate
  • string

Base64 Encoded certificate.

storeName enum:
  • CertificateAuthority
  • Root

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

CertificateInformation

SSL certificate information.

Name Type Description
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.

HostnameConfiguration

Custom hostname configuration.

Name Type Description
certificate

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.

hostName
  • string

Hostname to configure on the Api Management service.

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 MSI. 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.

type

Hostname type.

HostnameType

Hostname type.

Name Type Description
DeveloperPortal
  • string
Management
  • string
Portal
  • string
Proxy
  • string
Scm
  • string

SkuType

Name of the Sku.

Name Type Description
Basic
  • string

Basic SKU of Api Management.

Consumption
  • string

Consumption SKU of Api Management.

Developer
  • string

Developer SKU of Api Management.

Premium
  • string

Premium SKU of Api Management.

Standard
  • string

Standard SKU of Api Management.

VirtualNetworkConfiguration

Configuration of a virtual network to which API Management service is deployed.

Name Type Description
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.

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.

Name Type Description
External
  • string

The service is part of Virtual Network and it is accessible from Internet.

Internal
  • string

The service is part of Virtual Network and it is only accessible from within the virtual network.

None
  • string

The service is not part of any Virtual Network.