@datafire/azure_apimanagement_apimdeployment

Client library for ApiManagementClient

Installation and Usage

npm install --save @datafire/azure_apimanagement_apimdeployment

let azure_apimanagement_apimdeployment = require('@datafire/azure_apimanagement_apimdeployment').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Use these REST APIs to manage Azure API Management deployment.

Actions

ApiManagementOperations_List

Lists all of the available REST API operations of the Microsoft.ApiManagement provider.

azure_apimanagement_apimdeployment.ApiManagementOperations_List({
  "api-version": ""
}, context)

Input

• input object
  • api-version required string: Version of the API to be used with the client request.

Output

• output OperationListResult

ApiManagementService_CheckNameAvailability

Checks availability and correctness of a name for an API Management service.

azure_apimanagement_apimdeployment.ApiManagementService_CheckNameAvailability({
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • parameters required ApiManagementServiceCheckNameAvailabilityParameters
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ApiManagementServiceNameAvailabilityResult

ApiManagementService_List

Lists all API Management services within an Azure subscription.

azure_apimanagement_apimdeployment.ApiManagementService_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ApiManagementServiceListResult

ApiManagementService_ListByResourceGroup

List all API Management services within a resource group.

azure_apimanagement_apimdeployment.ApiManagementService_ListByResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ApiManagementServiceListResult

ApiManagementService_Delete

Deletes an existing API Management service.

azure_apimanagement_apimdeployment.ApiManagementService_Delete({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

ApiManagementService_Get

Gets an API Management service resource description.

azure_apimanagement_apimdeployment.ApiManagementService_Get({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ApiManagementServiceResource

ApiManagementService_Update

Updates an existing API Management service.

azure_apimanagement_apimdeployment.ApiManagementService_Update({
  "resourceGroupName": "",
  "serviceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • parameters required ApiManagementServiceUpdateParameters
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ApiManagementServiceResource

ApiManagementService_CreateOrUpdate

Creates or updates an API Management service. This is long running operation and could take several minutes to complete.

azure_apimanagement_apimdeployment.ApiManagementService_CreateOrUpdate({
  "resourceGroupName": "",
  "serviceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • parameters required ApiManagementServiceResource
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ApiManagementServiceResource

ApiManagementService_ApplyNetworkConfigurationUpdates

Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings.

azure_apimanagement_apimdeployment.ApiManagementService_ApplyNetworkConfigurationUpdates({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • parameters ApiManagementServiceApplyNetworkConfigurationParameters
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ApiManagementServiceResource

ApiManagementService_Backup

Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.

azure_apimanagement_apimdeployment.ApiManagementService_Backup({
  "resourceGroupName": "",
  "serviceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • parameters required ApiManagementServiceBackupRestoreParameters
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ApiManagementServiceResource

ApiManagementService_GetSsoToken

Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.

azure_apimanagement_apimdeployment.ApiManagementService_GetSsoToken({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ApiManagementServiceGetSsoTokenResult

ApiManagementService_Restore

Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.

azure_apimanagement_apimdeployment.ApiManagementService_Restore({
  "resourceGroupName": "",
  "serviceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • parameters required ApiManagementServiceBackupRestoreParameters
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ApiManagementServiceResource

ApiManagementServiceSkus_ListAvailableServiceSkus

Gets all available SKU for a given API Management service

azure_apimanagement_apimdeployment.ApiManagementServiceSkus_ListAvailableServiceSkus({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ResourceSkuResults

Definitions

AdditionalLocation

• AdditionalLocation object: Description of an additional API Management resource location.
  • gatewayRegionalUrl string: Gateway URL of the API Management service in the Region.
  • location required string: The location name of the additional region among Azure Data center regions.
  • privateIPAddresses array: 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.
    • items string
  • publicIPAddresses array: Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.
    • items string
  • sku required ApiManagementServiceSkuProperties
  • virtualNetworkConfiguration VirtualNetworkConfiguration

ApiManagementServiceApplyNetworkConfigurationParameters

• ApiManagementServiceApplyNetworkConfigurationParameters object: Parameter supplied to the Apply Network configuration operation.
  • location string: Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required.

ApiManagementServiceBackupRestoreParameters

• ApiManagementServiceBackupRestoreParameters object: Parameters supplied to the Backup/Restore of an API Management service operation.
  • accessKey required string: Azure Cloud Storage account (used to place/retrieve the backup) access key.
  • backupName required string: The name of the backup file to create.
  • containerName required string: Azure Cloud Storage blob container name used to place/retrieve the backup.
  • storageAccount required string: Azure Cloud Storage account (used to place/retrieve the backup) name.

ApiManagementServiceBaseProperties

• ApiManagementServiceBaseProperties object: Base Properties of an API Management service resource description.
  • additionalLocations array: Additional datacenter locations of the API Management service.
    • items AdditionalLocation
  • certificates array: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
    • items CertificateConfiguration
  • 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.
  • 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.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them.
  • 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.
  • gatewayRegionalUrl string: Gateway URL of the API Management service in the Default Region.
  • gatewayUrl string: Gateway URL of the API Management service.
  • hostnameConfigurations array: Custom hostname configuration of the API Management service.
    • items HostnameConfiguration
  • managementApiUrl string: Management API endpoint URL of the API Management service.
  • notificationSenderEmail string: Email address from which the notification will be sent.
  • portalUrl string: Publisher portal endpoint Url of the API Management service.
  • privateIPAddresses array: 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.
    • items string
  • provisioningState string: The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
  • publicIPAddresses array: Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
    • items string
  • scmUrl string: SCM endpoint URL of the API Management service.
  • targetProvisioningState string: The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
  • virtualNetworkConfiguration VirtualNetworkConfiguration
  • virtualNetworkType string (values: None, External, Internal): 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.

ApiManagementServiceCheckNameAvailabilityParameters

• ApiManagementServiceCheckNameAvailabilityParameters object: Parameters supplied to the CheckNameAvailability operation.
  • name required string: The name to check for availability.

ApiManagementServiceGetSsoTokenResult

• ApiManagementServiceGetSsoTokenResult object: The response of the GetSsoToken operation.
  • redirectUri string: Redirect URL to the Publisher Portal containing the SSO token.

ApiManagementServiceIdentity

• ApiManagementServiceIdentity object: Identity properties of the Api Management service resource.
  • principalId string: The principal id of the identity.
  • tenantId string: The client tenant id of the identity.
  • type required string (values: SystemAssigned): The identity type. Currently the only supported type is 'SystemAssigned'.

ApiManagementServiceListResult

• ApiManagementServiceListResult object: The response of the List API Management services operation.
  • nextLink string: Link to the next set of results. Not empty if Value contains incomplete list of API Management services.
  • value required array: Result of the List API Management services operation.
    • items ApiManagementServiceResource

ApiManagementServiceNameAvailabilityResult

• ApiManagementServiceNameAvailabilityResult object: Response of the CheckNameAvailability operation.
  • message string: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name.
  • nameAvailable boolean: True if the name is available and can be used to create a new API Management service; otherwise false.
  • reason string (values: Valid, Invalid, AlreadyExists): Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

ApiManagementServiceProperties

• ApiManagementServiceProperties object: Properties of an API Management service resource description.
  • publisherEmail required string: Publisher email.
  • publisherName required string: Publisher name.
  • additionalLocations array: Additional datacenter locations of the API Management service.
    • items AdditionalLocation
  • certificates array: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
    • items CertificateConfiguration
  • 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.
  • 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.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them.
  • 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.
  • gatewayRegionalUrl string: Gateway URL of the API Management service in the Default Region.
  • gatewayUrl string: Gateway URL of the API Management service.
  • hostnameConfigurations array: Custom hostname configuration of the API Management service.
    • items HostnameConfiguration
  • managementApiUrl string: Management API endpoint URL of the API Management service.
  • notificationSenderEmail string: Email address from which the notification will be sent.
  • portalUrl string: Publisher portal endpoint Url of the API Management service.
  • privateIPAddresses array: 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.
    • items string
  • provisioningState string: The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
  • publicIPAddresses array: Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
    • items string
  • scmUrl string: SCM endpoint URL of the API Management service.
  • targetProvisioningState string: The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
  • virtualNetworkConfiguration VirtualNetworkConfiguration
  • virtualNetworkType string (values: None, External, Internal): 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.

ApiManagementServiceResource

• ApiManagementServiceResource object: A single API Management service resource in List or Get response.
  • etag string: ETag of the resource.
  • identity ApiManagementServiceIdentity
  • location required string: Resource location.
  • properties required ApiManagementServiceProperties
  • sku required ApiManagementServiceSkuProperties
  • id string: Resource ID.
  • name string: Resource name.
  • tags object: Resource tags.
  • type string: Resource type for API Management resource is set to Microsoft.ApiManagement.

ApiManagementServiceSkuProperties

• ApiManagementServiceSkuProperties object: API Management service resource SKU properties.
  • capacity integer: Capacity of the SKU (number of deployed units of the SKU).
  • name required string (values: Developer, Standard, Premium, Basic, Consumption): Name of the Sku.

ApiManagementServiceUpdateParameters

• ApiManagementServiceUpdateParameters object: Parameter supplied to Update Api Management Service.
  • etag string: ETag of the resource.
  • identity ApiManagementServiceIdentity
  • properties ApiManagementServiceUpdateProperties
  • sku ApiManagementServiceSkuProperties
  • id string: Resource ID.
  • name string: Resource name.
  • tags object: Resource tags.
  • type string: Resource type for API Management resource is set to Microsoft.ApiManagement.

ApiManagementServiceUpdateProperties

• ApiManagementServiceUpdateProperties object: Properties of an API Management service resource description.
  • publisherEmail string: Publisher email.
  • publisherName string: Publisher name.
  • additionalLocations array: Additional datacenter locations of the API Management service.
    • items AdditionalLocation
  • certificates array: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
    • items CertificateConfiguration
  • 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.
  • 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.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them.
  • 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.
  • gatewayRegionalUrl string: Gateway URL of the API Management service in the Default Region.
  • gatewayUrl string: Gateway URL of the API Management service.
  • hostnameConfigurations array: Custom hostname configuration of the API Management service.
    • items HostnameConfiguration
  • managementApiUrl string: Management API endpoint URL of the API Management service.
  • notificationSenderEmail string: Email address from which the notification will be sent.
  • portalUrl string: Publisher portal endpoint Url of the API Management service.
  • privateIPAddresses array: 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.
    • items string
  • provisioningState string: The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
  • publicIPAddresses array: Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
    • items string
  • scmUrl string: SCM endpoint URL of the API Management service.
  • targetProvisioningState string: The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
  • virtualNetworkConfiguration VirtualNetworkConfiguration
  • virtualNetworkType string (values: None, External, Internal): 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.

ApimResource

• ApimResource object: The Resource definition.
  • id string: Resource ID.
  • name string: Resource name.
  • tags object: Resource tags.
  • type string: Resource type for API Management resource is set to Microsoft.ApiManagement.

CertificateConfiguration

• CertificateConfiguration object: Certificate configuration which consist of non-trusted intermediates and root certificates.
  • certificate CertificateInformation
  • certificatePassword string: Certificate Password.
  • encodedCertificate string: Base64 Encoded certificate.
  • storeName required string (values: CertificateAuthority, Root): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

CertificateInformation

• CertificateInformation object: SSL certificate information.
  • expiry required 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 required string: Subject of the certificate.
  • thumbprint required string: Thumbprint of the certificate.

HostnameConfiguration

• HostnameConfiguration object: Custom hostname configuration.
  • certificate CertificateInformation
  • 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 required 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 required string (values: Proxy, Portal, Management, Scm, DeveloperPortal): Hostname type.

Operation

• Operation object: REST API operation
  • display object: The object that describes the operation.
    • description string: Friendly name of the operation
    • operation string: Operation type: read, write, delete, listKeys/action, etc.
    • provider string: Friendly name of the resource provider
    • resource string: Resource type on which the operation is performed.
  • name string: Operation name: {provider}/{resource}/{operation}
  • origin string: The operation origin.
  • properties object: The operation properties.

OperationListResult

• OperationListResult object: Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.
  • nextLink string: URL to get the next set of operation list results if there are any.
  • value array: List of operations supported by the resource provider.
    • items Operation

ResourceSku

• ResourceSku object: Describes an available API Management SKU.
  • name string (values: Developer, Standard, Premium, Basic, Consumption): Name of the Sku.

ResourceSkuCapacity

• ResourceSkuCapacity object: Describes scaling information of a SKU.
  • default integer: The default capacity.
  • maximum integer: The maximum capacity that can be set.
  • minimum integer: The minimum capacity.
  • scaleType string (values: automatic, manual, none): The scale type applicable to the sku.

ResourceSkuResult

• ResourceSkuResult object: Describes an available API Management service SKU.
  • capacity ResourceSkuCapacity
  • resourceType string: The type of resource the SKU applies to.
  • sku ResourceSku

ResourceSkuResults

• ResourceSkuResults object: The API Management service SKUs operation response.
  • nextLink string: The uri to fetch the next page of API Management service Skus.
  • value required array: The list of skus available for the service.
    • items ResourceSkuResult

VirtualNetworkConfiguration

• VirtualNetworkConfiguration object: Configuration of a virtual network to which API Management service is deployed.
  • 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.