apimanagement.azure.com/v1api20230501preview

"2023-05-01-preview"

DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

Location: The location name of the additional region among Azure Data center regions.

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

PublicIpAddressReference: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.

Sku: SKU properties of the API Management service.

VirtualNetworkConfiguration: Virtual network configuration for the location.

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

DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

Location: The location name of the additional region among Azure Data center regions.

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

Sku: SKU properties of the API Management service.

VirtualNetworkConfiguration: Virtual network configuration for the location.

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

"Disabled"

"Enabled"

"Disabled"

"Enabled"

"mtv1"

"stv1"

"stv2"

"stv2.1"

"undetermined"

DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

GatewayRegionalUrl: Gateway URL of the API Management service in the Region.

Location: The location name of the additional region among Azure Data center regions.

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

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

PlatformVersion: Compute Platform Version running the service.

PrivateIPAddresses: 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, Premium and Isolated SKU.

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

PublicIpAddressId: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.

Sku: SKU properties of the API Management service.

VirtualNetworkConfiguration: Virtual network configuration for the location.

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

DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

GatewayRegionalUrl: Gateway URL of the API Management service in the Region.

Location: The location name of the additional region among Azure Data center regions.

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

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

PlatformVersion: Compute Platform Version running the service.

PrivateIPAddresses: 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, Premium and Isolated SKU.

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

PublicIpAddressId: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.

Sku: SKU properties of the API Management service.

VirtualNetworkConfiguration: Virtual network configuration for the location.

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

Email: The email address of the contact person/organization. MUST be in the format of an email address

Name: The identifying name of the contact person/organization

Url: The URL pointing to the contact information. MUST be in the format of a URL

Email: The email address of the contact person/organization. MUST be in the format of an email address

Name: The identifying name of the contact person/organization

Url: The URL pointing to the contact information. MUST be in the format of a URL

Email: The email address of the contact person/organization. MUST be in the format of an email address

Name: The identifying name of the contact person/organization

Url: The URL pointing to the contact information. MUST be in the format of a URL

Email: The email address of the contact person/organization. MUST be in the format of an email address

Name: The identifying name of the contact person/organization

Url: The URL pointing to the contact information. MUST be in the format of a URL

"http"

"https"

"ws"

"wss"

APIVersion: Indicates the version identifier of the API if the API is versioned

ApiRevision: Describes the revision of the API. If no value is provided, default revision 1 is created

ApiRevisionDescription: Description of the API Revision.

ApiVersionDescription: Description of the API Version.

ApiVersionSet: Version set details

ApiVersionSetId: A resource identifier for the related ApiVersionSet.

AuthenticationSettings: Collection of authentication settings included into this API.

Contact: Contact information for the API.

Description: Description of the API. May include HTML formatting tags.

DisplayName: API name. Must be 1 to 300 characters long.

IsCurrent: Indicates if API revision is current api revision.

IsOnline: Indicates if API revision is accessible via the gateway.

License: License information for the API.

Path: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Protocols: Describes on which protocols the operations in this API can be invoked.

ProvisioningState: The provisioning state

ServiceUrl: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

SourceApiId: API identifier of the source API.

SubscriptionKeyParameterNames: Protocols over which API is made available.

SubscriptionRequired: Specifies whether an API or Product subscription is required for accessing the API.

TermsOfServiceUrl: A URL to the Terms of Service for the API. MUST be in the format of a URL.

Type: Type of API.

"graphql"

"grpc"

"http"

"odata"

"soap"

"websocket"

APIVersion: Indicates the version identifier of the API if the API is versioned

ApiRevision: Describes the revision of the API. If no value is provided, default revision 1 is created

ApiRevisionDescription: Description of the API Revision.

ApiType: Type of API to create. * http creates a REST API * soap creates a SOAP pass-through API * websocket creates websocket API * graphql creates GraphQL API. New types can be added in the future.

ApiVersionDescription: Description of the API Version.

ApiVersionSet: Version set details

AuthenticationSettings: Collection of authentication settings included into this API.

Contact: Contact information for the API.

Description: Description of the API. May include HTML formatting tags.

DisplayName: API name. Must be 1 to 300 characters long.

Format: Format of the Content in which the API is getting imported. New formats can be added in the future

IsCurrent: Indicates if API revision is current api revision.

License: License information for the API.

Path: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Protocols: Describes on which protocols the operations in this API can be invoked.

ServiceUrl: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

SubscriptionKeyParameterNames: Protocols over which API is made available.

SubscriptionRequired: Specifies whether an API or Product subscription is required for accessing the API.

TermsOfServiceUrl: A URL to the Terms of Service for the API. MUST be in the format of a URL.

TranslateRequiredQueryParameters: Strategy of translating required query parameters to template ones. By default has value ‘template’. Possible values: ‘template’, ‘query’

Type: Type of API.

Value: Content value when Importing an API.

WsdlSelector: Criteria to limit import of WSDL to a subset of the document.

"graphql"

"grpc"

"http"

"odata"

"soap"

"websocket"

"graphql-link"

"grpc"

"grpc-link"

"odata"

"odata-link"

"openapi"

"openapi+json"

"openapi+json-link"

"openapi-link"

"swagger-json"

"swagger-link-json"

"wadl-link-json"

"wadl-xml"

"wsdl"

"wsdl-link"

"http"

"https"

"ws"

"wss"

"query"

"template"

"graphql"

"grpc"

"http"

"odata"

"soap"

"websocket"

WsdlEndpointName: Name of endpoint(port) to import from WSDL

WsdlServiceName: Name of service to import from WSDL

WsdlEndpointName: Name of endpoint(port) to import from WSDL

WsdlServiceName: Name of service to import from WSDL

Name: The license name used for the API

Url: A URL to the license used for the API. MUST be in the format of a URL

Name: The license name used for the API

Url: A URL to the license used for the API. MUST be in the format of a URL

Name: The license name used for the API

Url: A URL to the license used for the API. MUST be in the format of a URL

Name: The license name used for the API

Url: A URL to the license used for the API. MUST be in the format of a URL

Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service.

UserAssignedIdentities: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service.

PrincipalId: The principal id of the identity.

TenantId: The client tenant id of the identity.

Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service.

UserAssignedIdentities: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

PrincipalId: The principal id of the identity.

TenantId: The client tenant id of the identity.

Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service.

UserAssignedIdentities: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

"None"

"SystemAssigned"

"SystemAssigned, UserAssigned"

"UserAssigned"

"None"

"SystemAssigned"

"SystemAssigned, UserAssigned"

"UserAssigned"

AdditionalLocations: Additional datacenter locations of the API Management service.

ApiVersionConstraint: Control Plane Apis version constraint for the API Management service.

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

ConfigurationApi: Configuration API configuration of the API Management service.

CustomProperties: Custom properties of the API Management service.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.
Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1, 2018 and False otherwise. Http2 setting’s default value is False.

You can disable any of the following ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them.
Note: The following ciphers can’t be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

DeveloperPortalStatus: Status of developer portal in this API Management service.

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

EnableClientCertificate: 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.

HostnameConfigurations: Custom hostname configuration of the API Management service.

LegacyPortalStatus: Status of legacy portal in the API Management service.

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

NotificationSenderEmail: Email address from which the notification will be sent.

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

PublisherEmail: Publisher email.

PublisherName: Publisher name.

Restore: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.

VirtualNetworkConfiguration: Virtual network configuration of the API Management service.

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.

"Disabled"

"Enabled"

"Disabled"

"Enabled"

"Disabled"

"Enabled"

"Disabled"

"Enabled"

"Disabled"

"Enabled"

"Disabled"

"Enabled"

"mtv1"

"stv1"

"stv2"

"stv2.1"

"undetermined"

"Disabled"

"Enabled"

"Disabled"

"Enabled"

AdditionalLocations: Additional datacenter locations of the API Management service.

ApiVersionConstraint: Control Plane Apis version constraint for the API Management service.

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

ConfigurationApi: Configuration API configuration of the API Management service.

CreatedAtUtc: 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: Custom properties of the API Management service.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.
Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.
Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1, 2018 and False otherwise. Http2 setting’s default value is False.

You can disable any of the following ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them.
Note: The following ciphers can’t be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

DeveloperPortalStatus: Status of developer portal in this API Management service.

DeveloperPortalUrl: DEveloper Portal endpoint URL of the API Management service.

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

EnableClientCertificate: 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: Gateway URL of the API Management service in the Default Region.

GatewayUrl: Gateway URL of the API Management service.

HostnameConfigurations: Custom hostname configuration of the API Management service.

LegacyPortalStatus: Status of legacy portal in the API Management service.

ManagementApiUrl: Management API endpoint URL of the API Management service.

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

NotificationSenderEmail: Email address from which the notification will be sent.

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

PlatformVersion: Compute Platform Version running the service in this location.

PortalUrl: Publisher portal endpoint Url of the API Management service.

PrivateEndpointConnections: List of Private Endpoint Connections of this service.

PrivateIPAddresses: Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.

ProvisioningState: 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: Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.

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

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

PublisherEmail: Publisher email.

PublisherName: Publisher name.

Restore: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.

ScmUrl: SCM endpoint URL of the API Management service.

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

VirtualNetworkConfiguration: Virtual network configuration of the API Management service.

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.

"External"

"Internal"

"None"

"External"

"Internal"

"None"

Capacity: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

Name: Name of the Sku.

Capacity: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

Name: Name of the Sku.

"Basic"

"BasicV2"

"Consumption"

"Developer"

"Isolated"

"Premium"

"Standard"

"StandardV2"

"Basic"

"BasicV2"

"Consumption"

"Developer"

"Isolated"

"Premium"

"Standard"

"StandardV2"

Capacity: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

Name: Name of the Sku.

Capacity: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

Name: Name of the Sku.

MinApiVersion: Limit control plane API calls to API Management service with version equal to or newer than this value.

MinApiVersion: Limit control plane API calls to API Management service with version equal to or newer than this value.

MinApiVersion: Limit control plane API calls to API Management service with version equal to or newer than this value.

MinApiVersion: Limit control plane API calls to API Management service with version equal to or newer than this value.

Description: Description of API Version Set.

Name: The display Name of the API Version Set.

Reference: Identifier for existing API Version Set. Omit this value to create a new Version Set.

VersionHeaderName: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

VersionQueryName: Name of query parameter that indicates the API Version if versioningScheme is set to query.

VersioningScheme: An value that determines where the API Version identifier will be located in a HTTP request.

Description: Description of API Version Set.

Name: The display Name of the API Version Set.

VersionHeaderName: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

VersionQueryName: Name of query parameter that indicates the API Version if versioningScheme is set to query.

VersioningScheme: An value that determines where the API Version identifier will be located in a HTTP request.

Description: Description of API Version Set.

Id: Identifier for existing API Version Set. Omit this value to create a new Version Set.

Name: The display Name of the API Version Set.

VersionHeaderName: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

VersionQueryName: Name of query parameter that indicates the API Version if versioningScheme is set to query.

VersioningScheme: An value that determines where the API Version identifier will be located in a HTTP request.

Description: Description of API Version Set.

Id: Identifier for existing API Version Set. Omit this value to create a new Version Set.

Name: The display Name of the API Version Set.

VersionHeaderName: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

VersionQueryName: Name of query parameter that indicates the API Version if versioningScheme is set to query.

VersioningScheme: An value that determines where the API Version identifier will be located in a HTTP request.

"Header"

"Query"

"Segment"

"Header"

"Query"

"Segment"

Description: Description of API Version Set.

DisplayName: Name of API Version Set

VersionHeaderName: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

VersionQueryName: Name of query parameter that indicates the API Version if versioningScheme is set to query.

VersioningScheme: An value that determines where the API Version identifier will be located in a HTTP request.

Description: Description of API Version Set.

DisplayName: Name of API Version Set

VersionHeaderName: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

VersionQueryName: Name of query parameter that indicates the API Version if versioningScheme is set to query.

VersioningScheme: An value that determines where the API Version identifier will be located in a HTTP request.

"Header"

"Query"

"Segment"

"Header"

"Query"

"Segment"

OAuth2: OAuth2 Authentication settings

OAuth2AuthenticationSettings: Collection of OAuth2 authentication settings included into this API.

Openid: OpenID Connect Authentication Settings

OpenidAuthenticationSettings: Collection of Open ID Connect authentication settings included into this API.

OAuth2: OAuth2 Authentication settings

OAuth2AuthenticationSettings: Collection of OAuth2 authentication settings included into this API.

Openid: OpenID Connect Authentication Settings

OpenidAuthenticationSettings: Collection of Open ID Connect authentication settings included into this API.

OAuth2: OAuth2 Authentication settings

OAuth2AuthenticationSettings: Collection of OAuth2 authentication settings included into this API.

Openid: OpenID Connect Authentication Settings

OpenidAuthenticationSettings: Collection of Open ID Connect authentication settings included into this API.

OAuth2: OAuth2 Authentication settings

OAuth2AuthenticationSettings: Collection of OAuth2 authentication settings included into this API.

Openid: OpenID Connect Authentication Settings

OpenidAuthenticationSettings: Collection of Open ID Connect authentication settings included into this API.

AppIds: The allowed Azure Active Directory Application IDs

ObjectId: The Object Id

TenantId: The Tenant Id

AppIds: The allowed Azure Active Directory Application IDs

ObjectId: The Object Id

TenantId: The Tenant Id

AuthorizationType: Authorization type options

Oauth2GrantType: OAuth2 grant type options

Parameters: Authorization parameters

"OAuth2"

"OAuth2"

"AuthorizationCode"

"ClientCredentials"

"AuthorizationCode"

"ClientCredentials"

AuthorizationType: Authorization type options

Error: Authorization error details.

Oauth2GrantType: OAuth2 grant type options

Parameters: Authorization parameters

Status: Status of the Authorization

Code: Error code

Message: Error message

Code: Error code

Message: Error message

DisplayName: Authorization Provider name. Must be 1 to 300 characters long.

IdentityProvider: Identity provider name. Must be 1 to 300 characters long.

Oauth2: OAuth2 settings

DisplayName: Authorization Provider name. Must be 1 to 300 characters long.

IdentityProvider: Identity provider name. Must be 1 to 300 characters long.

Oauth2: OAuth2 settings

AuthorizationCode: OAuth2 authorization code grant parameters

ClientCredentials: OAuth2 client credential grant parameters

AuthorizationCode: OAuth2 authorization code grant parameters

ClientCredentials: OAuth2 client credential grant parameters

AuthorizationCode: OAuth2 authorization code grant parameters

ClientCredentials: OAuth2 client credential grant parameters

AuthorizationCode: OAuth2 authorization code grant parameters

ClientCredentials: OAuth2 client credential grant parameters

GrantTypes: OAuth2 settings

RedirectUrl: Redirect URL to be set in the OAuth application.

GrantTypes: OAuth2 settings

RedirectUrl: Redirect URL to be set in the OAuth application.

GrantTypes: OAuth2 settings

RedirectUrl: Redirect URL to be set in the OAuth application.

GrantTypes: OAuth2 settings

RedirectUrl: Redirect URL to be set in the OAuth application.

Parameter: Authentication Parameter value.

Scheme: Authentication Scheme name.

Parameter: Authentication Parameter value.

Scheme: Authentication Scheme name.

Parameter: Authentication Parameter value.

Scheme: Authentication Scheme name.

Parameter: Authentication Parameter value.

Scheme: Authentication Scheme name.

Rules: The rules for tripping the backend.

Rules: The rules for tripping the backend.

Rules: The rules for tripping the backend.

Rules: The rules for tripping the backend.

CircuitBreaker: Backend Circuit Breaker Configuration

Credentials: Backend Credentials Contract Properties

Description: Backend Description.

Pool: Backend pool information

Properties: Backend Properties contract

Protocol: Backend communication protocol.

Proxy: Backend gateway Contract Properties

Title: Backend Title.

Tls: Backend TLS Properties

Type: Type of the backend. A backend can be either Single or Pool.

Url: Runtime Url of the Backend.

"http"

"soap"

"http"

"soap"

CircuitBreaker: Backend Circuit Breaker Configuration

Credentials: Backend Credentials Contract Properties

Description: Backend Description.

Pool: Backend pool information

Properties: Backend Properties contract

Protocol: Backend communication protocol.

Proxy: Backend gateway Contract Properties

ResourceId: Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.

Title: Backend Title.

Tls: Backend TLS Properties

Type: Type of the backend. A backend can be either Single or Pool.

Url: Runtime Url of the Backend.

"Pool"

"Single"

"Pool"

"Single"

Authorization: Authorization header authentication

Certificate: List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.

CertificateIds: List of Client Certificate Ids.

Header: Header Parameter description.

Query: Query Parameter description.

Authorization: Authorization header authentication

Certificate: List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.

CertificateIds: List of Client Certificate Ids.

Header: Header Parameter description.

Query: Query Parameter description.

Authorization: Authorization header authentication

Certificate: List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.

CertificateIds: List of Client Certificate Ids.

Header: Header Parameter description.

Query: Query Parameter description.

Authorization: Authorization header authentication

Certificate: List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.

CertificateIds: List of Client Certificate Ids.

Header: Header Parameter description.

Query: Query Parameter description.

Services: The list of backend entities belonging to a pool.

Reference: The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.

Id: The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.

Id: The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.

Services: The list of backend entities belonging to a pool.

Services: The list of backend entities belonging to a pool.

Services: The list of backend entities belonging to a pool.

ServiceFabricCluster: Backend Service Fabric Cluster Properties

ServiceFabricCluster: Backend Service Fabric Cluster Properties

ServiceFabricCluster: Backend Service Fabric Cluster Properties

ServiceFabricCluster: Backend Service Fabric Cluster Properties

Password: Password to connect to the WebProxy Server

Url: WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.

Username: Username to connect to the WebProxy server

Password: Password to connect to the WebProxy Server

Url: WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.

Username: Username to connect to the WebProxy server

Url: WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.

Username: Username to connect to the WebProxy server

Url: WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.

Username: Username to connect to the WebProxy server

ClientCertificateId: The client certificate id for the management endpoint.

ClientCertificatethumbprint: The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided

ManagementEndpoints: The cluster management endpoint.

MaxPartitionResolutionRetries: Maximum number of retries while attempting resolve the partition.

ServerCertificateThumbprints: Thumbprints of certificates cluster management service uses for tls communication

ServerX509Names: Server X509 Certificate Names Collection

ClientCertificateId: The client certificate id for the management endpoint.

ClientCertificatethumbprint: The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided

ManagementEndpoints: The cluster management endpoint.

MaxPartitionResolutionRetries: Maximum number of retries while attempting resolve the partition.

ServerCertificateThumbprints: Thumbprints of certificates cluster management service uses for tls communication

ServerX509Names: Server X509 Certificate Names Collection

ClientCertificateId: The client certificate id for the management endpoint.

ClientCertificatethumbprint: The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided

ManagementEndpoints: The cluster management endpoint.

MaxPartitionResolutionRetries: Maximum number of retries while attempting resolve the partition.

ServerCertificateThumbprints: Thumbprints of certificates cluster management service uses for tls communication

ServerX509Names: Server X509 Certificate Names Collection

ClientCertificateId: The client certificate id for the management endpoint.

ClientCertificatethumbprint: The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided

ManagementEndpoints: The cluster management endpoint.

MaxPartitionResolutionRetries: Maximum number of retries while attempting resolve the partition.

ServerCertificateThumbprints: Thumbprints of certificates cluster management service uses for tls communication

ServerX509Names: Server X509 Certificate Names Collection

ValidateCertificateChain: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.

ValidateCertificateName: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.

ValidateCertificateChain: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.

ValidateCertificateName: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.

ValidateCertificateChain: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.

ValidateCertificateName: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.

ValidateCertificateChain: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.

ValidateCertificateName: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.

"authorizationHeader"

"query"

"authorizationHeader"

"query"

Certificate: Certificate information.

CertificatePassword: Certificate Password.

EncodedCertificate: Base64 Encoded certificate.

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

Certificate: Certificate information.

CertificatePassword: Certificate Password.

EncodedCertificate: Base64 Encoded certificate.

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

Certificate: Certificate information.

EncodedCertificate: Base64 Encoded certificate.

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

Certificate: Certificate information.

EncodedCertificate: Base64 Encoded certificate.

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

"CertificateAuthority"

"Root"

"CertificateAuthority"

"Root"

Expiry: Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

ExpiryFromConfig: 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: Subject of the certificate.

SubjectFromConfig: Subject of the certificate.

Thumbprint: Thumbprint of the certificate.

ThumbprintFromConfig: Thumbprint of the certificate.

Expiry: 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: Subject of the certificate.

Thumbprint: Thumbprint of the certificate.

Expiry: 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: Subject of the certificate.

Thumbprint: Thumbprint of the certificate.

Expiry: 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: Subject of the certificate.

Thumbprint: Thumbprint of the certificate.

Count: The threshold for opening the circuit.

ErrorReasons: The error reasons which are considered as failure.

Interval: The interval during which the failures are counted.

Percentage: The threshold for opening the circuit.

StatusCodeRanges: The status code ranges which are considered as failure.

Count: The threshold for opening the circuit.

ErrorReasons: The error reasons which are considered as failure.

Interval: The interval during which the failures are counted.

Percentage: The threshold for opening the circuit.

StatusCodeRanges: The status code ranges which are considered as failure.

Count: The threshold for opening the circuit.

ErrorReasons: The error reasons which are considered as failure.

Interval: The interval during which the failures are counted.

Percentage: The threshold for opening the circuit.

StatusCodeRanges: The status code ranges which are considered as failure.

Count: The threshold for opening the circuit.

ErrorReasons: The error reasons which are considered as failure.

Interval: The interval during which the failures are counted.

Percentage: The threshold for opening the circuit.

StatusCodeRanges: The status code ranges which are considered as failure.

FailureCondition: The conditions for tripping the circuit breaker.

Name: The rule name.

TripDuration: The duration for which the circuit will be tripped.

FailureCondition: The conditions for tripping the circuit breaker.

Name: The rule name.

TripDuration: The duration for which the circuit will be tripped.

FailureCondition: The conditions for tripping the circuit breaker.

Name: The rule name.

TripDuration: The duration for which the circuit will be tripped.

FailureCondition: The conditions for tripping the circuit breaker.

Name: The rule name.

TripDuration: The duration for which the circuit will be tripped.

LegacyApi: Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be ‘Enabled’ or ‘Disabled’. If ‘Disabled’, legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is ‘Enabled’

LegacyApi: Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be ‘Enabled’ or ‘Disabled’. If ‘Disabled’, legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is ‘Enabled’

"Disabled"

"Enabled"

"Disabled"

"Enabled"

LegacyApi: Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be ‘Enabled’ or ‘Disabled’. If ‘Disabled’, legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is ‘Enabled’

LegacyApi: Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be ‘Enabled’ or ‘Disabled’. If ‘Disabled’, legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is ‘Enabled’

Max: The maximum http status code.

Min: The minimum http status code.

Max: The maximum http status code.

Min: The minimum http status code.

Max: The maximum http status code.

Min: The minimum http status code.

Max: The maximum http status code.

Min: The minimum http status code.

Certificate: Certificate information.

CertificatePassword: Certificate Password.

CertificateSource: Certificate Source.

CertificateStatus: Certificate Status.

DefaultSslBinding: 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 gateway Hostname Type.

EncodedCertificate: Base64 Encoded certificate.

HostName: Hostname to configure on the Api Management service.

IdentityClientId: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

IdentityClientIdFromConfig: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

KeyVaultId: 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 aka.ms/apimmsi. The secret should be of type application/x-pkcs12

NegotiateClientCertificate: Specify true to always negotiate client certificate on the hostname. Default Value is false.

Type: Hostname type.

Certificate: Certificate information.

CertificatePassword: Certificate Password.

CertificateSource: Certificate Source.

CertificateStatus: Certificate Status.

DefaultSslBinding: 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 gateway Hostname Type.

EncodedCertificate: Base64 Encoded certificate.

HostName: Hostname to configure on the Api Management service.

IdentityClientId: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

KeyVaultId: 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 aka.ms/apimmsi. The secret should be of type application/x-pkcs12

NegotiateClientCertificate: Specify true to always negotiate client certificate on the hostname. Default Value is false.

Type: Hostname type.

"BuiltIn"

"Custom"

"KeyVault"

"Managed"

"BuiltIn"

"Custom"

"KeyVault"

"Managed"

"Completed"

"Failed"

"InProgress"

"Completed"

"Failed"

"InProgress"

Certificate: Certificate information.

CertificateSource: Certificate Source.

CertificateStatus: Certificate Status.

DefaultSslBinding: 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 gateway Hostname Type.

EncodedCertificate: Base64 Encoded certificate.

HostName: Hostname to configure on the Api Management service.

IdentityClientId: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

KeyVaultId: 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 aka.ms/apimmsi. The secret should be of type application/x-pkcs12

NegotiateClientCertificate: Specify true to always negotiate client certificate on the hostname. Default Value is false.

Type: Hostname type.

Certificate: Certificate information.

CertificateSource: Certificate Source.

CertificateStatus: Certificate Status.

DefaultSslBinding: 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 gateway Hostname Type.

EncodedCertificate: Base64 Encoded certificate.

HostName: Hostname to configure on the Api Management service.

IdentityClientId: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

KeyVaultId: 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 aka.ms/apimmsi. The secret should be of type application/x-pkcs12

NegotiateClientCertificate: Specify true to always negotiate client certificate on the hostname. Default Value is false.

Type: Hostname type.

"ConfigurationApi"

"DeveloperPortal"

"Management"

"Portal"

"Proxy"

"Scm"

"ConfigurationApi"

"DeveloperPortal"

"Management"

"Portal"

"Proxy"

"Scm"

IdentityClientId: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

IdentityClientIdFromConfig: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

SecretIdentifier: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi

IdentityClientId: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

SecretIdentifier: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi

IdentityClientId: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

LastStatus: Last time sync and refresh status of secret from key vault.

SecretIdentifier: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi

IdentityClientId: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

LastStatus: Last time sync and refresh status of secret from key vault.

SecretIdentifier: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi

Code: Last status code for sync and refresh of secret from key vault.

Message: Details of the error else empty.

TimeStampUtc: Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Code: Last status code for sync and refresh of secret from key vault.

Message: Details of the error else empty.

TimeStampUtc: Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

DisplayName: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.

KeyVault: KeyVault location details of the namedValue.

ProvisioningState: The provisioning state

Secret: Determines whether the value is a secret and should be encrypted or not. Default value is false.

Tags: Optional tags that when provided can be used to filter the NamedValue list.

Value: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

DisplayName: Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.

KeyVault: KeyVault location details of the namedValue.

Secret: Determines whether the value is a secret and should be encrypted or not. Default value is false.

Tags: Optional tags that when provided can be used to filter the NamedValue list.

Value: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

AuthorizationServerId: OAuth authorization server identifier.

Scope: operations scope.

AuthorizationServerId: OAuth authorization server identifier.

Scope: operations scope.

AuthorizationServerId: OAuth authorization server identifier.

Scope: operations scope.

AuthorizationServerId: OAuth authorization server identifier.

Scope: operations scope.

BearerTokenSendingMethods: How to send token to the server.

OpenidProviderId: OAuth authorization server identifier.

BearerTokenSendingMethods: How to send token to the server.

OpenidProviderId: OAuth authorization server identifier.

BearerTokenSendingMethods: How to send token to the server.

OpenidProviderId: OAuth authorization server identifier.

BearerTokenSendingMethods: How to send token to the server.

OpenidProviderId: OAuth authorization server identifier.

Format: Format of the policyContent.

Value: Contents of the Policy as defined by the format.