diff --git a/schemas/2021-04-01-preview/Microsoft.ApiManagement.json b/schemas/2021-04-01-preview/Microsoft.ApiManagement.json new file mode 100644 index 0000000000..8744dd9612 --- /dev/null +++ b/schemas/2021-04-01-preview/Microsoft.ApiManagement.json @@ -0,0 +1,8117 @@ +{ + "id": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.ApiManagement", + "description": "Microsoft ApiManagement Resource Types", + "resourceDefinitions": { + "service": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/ApiManagementServiceIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity properties of the Api Management service resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 50 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the API Management service." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApiManagementServiceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of an API Management service resource description." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/service_apis_childResource" + }, + { + "$ref": "#/definitions/service_tags_childResource" + }, + { + "$ref": "#/definitions/service_apiVersionSets_childResource" + }, + { + "$ref": "#/definitions/service_authorizationServers_childResource" + }, + { + "$ref": "#/definitions/service_backends_childResource" + }, + { + "$ref": "#/definitions/service_caches_childResource" + }, + { + "$ref": "#/definitions/service_certificates_childResource" + }, + { + "$ref": "#/definitions/service_contentTypes_childResource" + }, + { + "$ref": "#/definitions/service_diagnostics_childResource" + }, + { + "$ref": "#/definitions/service_templates_childResource" + }, + { + "$ref": "#/definitions/service_gateways_childResource" + }, + { + "$ref": "#/definitions/service_groups_childResource" + }, + { + "$ref": "#/definitions/service_identityProviders_childResource" + }, + { + "$ref": "#/definitions/service_loggers_childResource" + }, + { + "$ref": "#/definitions/service_namedValues_childResource" + }, + { + "$ref": "#/definitions/service_notifications_childResource" + }, + { + "$ref": "#/definitions/service_openidConnectProviders_childResource" + }, + { + "$ref": "#/definitions/service_policies_childResource" + }, + { + "$ref": "#/definitions/service_portalRevisions_childResource" + }, + { + "$ref": "#/definitions/service_portalsettings_childResource" + }, + { + "$ref": "#/definitions/service_privateEndpointConnections_childResource" + }, + { + "$ref": "#/definitions/service_products_childResource" + }, + { + "$ref": "#/definitions/service_subscriptions_childResource" + }, + { + "$ref": "#/definitions/service_tenant_childResource" + }, + { + "$ref": "#/definitions/service_users_childResource" + } + ] + } + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/ApiManagementServiceSkuProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API Management service resource SKU properties." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of availability zones denoting where the resource needs to come from." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "sku", + "type" + ], + "description": "Microsoft.ApiManagement/service" + }, + "service_apis": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApiCreateOrUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API Create or Update Properties." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/service_apis_releases_childResource" + }, + { + "$ref": "#/definitions/service_apis_operations_childResource" + }, + { + "$ref": "#/definitions/service_apis_tags_childResource" + }, + { + "$ref": "#/definitions/service_apis_policies_childResource" + }, + { + "$ref": "#/definitions/service_apis_schemas_childResource" + }, + { + "$ref": "#/definitions/service_apis_diagnostics_childResource" + }, + { + "$ref": "#/definitions/service_apis_issues_childResource" + }, + { + "$ref": "#/definitions/service_apis_tagDescriptions_childResource" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis" + }, + "service_apis_diagnostics": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Diagnostic identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Diagnostic Entity Properties" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/diagnostics" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/diagnostics" + }, + "service_apis_issues": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Issue identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IssueContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Issue contract Properties." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/service_apis_issues_comments_childResource" + }, + { + "$ref": "#/definitions/service_apis_issues_attachments_childResource" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/issues" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/issues" + }, + "service_apis_issues_attachments": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Attachment identifier within an Issue. Must be unique in the current Issue." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IssueAttachmentContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Issue Attachment contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/issues/attachments" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/issues/attachments" + }, + "service_apis_issues_comments": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Comment identifier within an Issue. Must be unique in the current Issue." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IssueCommentContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Issue Comment contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/issues/comments" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/issues/comments" + }, + "service_apis_operations": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Operation identifier within an API. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/OperationContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Operation Contract Properties" + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/service_apis_operations_policies_childResource" + }, + { + "$ref": "#/definitions/service_apis_operations_tags_childResource" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/operations" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/operations" + }, + "service_apis_operations_policies": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/policy$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The identifier of the Policy." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PolicyContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Policy contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/operations/policies" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/operations/policies" + }, + "service_apis_operations_tags": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/operations/tags" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/operations/tags" + }, + "service_apis_policies": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/policy$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The identifier of the Policy." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PolicyContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Policy contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/policies" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/policies" + }, + "service_apis_releases": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Release identifier within an API. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApiReleaseContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API Release details" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/releases" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/releases" + }, + "service_apis_schemas": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Schema identifier within an API. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SchemaContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API Schema create or update contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/schemas" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/schemas" + }, + "service_apis_tagDescriptions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/TagDescriptionBaseProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the Create TagDescription operation." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/tagDescriptions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/tagDescriptions" + }, + "service_apis_tags": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apis/tags" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/tags" + }, + "service_apiVersionSets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Api Version Set identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApiVersionSetContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of an API Version Set." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/apiVersionSets" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apiVersionSets" + }, + "service_authorizationServers": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the authorization server." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AuthorizationServerContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "External OAuth authorization server settings Properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/authorizationServers" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/authorizationServers" + }, + "service_backends": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/BackendContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the Create Backend operation." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/backends" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/backends" + }, + "service_caches": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier)." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CacheContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the Cache contract." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/caches" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/caches" + }, + "service_certificates": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateCreateOrUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the CreateOrUpdate certificate operation." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/certificates" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/certificates" + }, + "service_contentTypes": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Content type identifier." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/service_contentTypes_contentItems_childResource" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/contentTypes" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/contentTypes" + }, + "service_contentTypes_contentItems": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Content item identifier." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/contentTypes/contentItems" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/contentTypes/contentItems" + }, + "service_diagnostics": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Diagnostic identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Diagnostic Entity Properties" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/diagnostics" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/diagnostics" + }, + "service_gateways": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GatewayContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the Gateway contract." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/service_gateways_hostnameConfigurations_childResource" + }, + { + "$ref": "#/definitions/service_gateways_apis_childResource" + }, + { + "$ref": "#/definitions/service_gateways_certificateAuthorities_childResource" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/gateways" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/gateways" + }, + "service_gateways_apis": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "API identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AssociationContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Association entity contract properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/gateways/apis" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/gateways/apis" + }, + "service_gateways_certificateAuthorities": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GatewayCertificateAuthorityContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Gateway certificate authority details." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/gateways/certificateAuthorities" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/gateways/certificateAuthorities" + }, + "service_gateways_hostnameConfigurations": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GatewayHostnameConfigurationContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Gateway hostname configuration details." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/gateways/hostnameConfigurations" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations" + }, + "service_groups": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 256, + "description": "Group identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GroupCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the Create Group operation." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/service_groups_users_childResource" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/groups" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/groups" + }, + "service_groups_users": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "User identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/groups/users" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/groups/users" + }, + "service_identityProviders": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity Provider Type identifier." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IdentityProviderCreateContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/identityProviders" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/identityProviders" + }, + "service_loggers": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Logger identifier. Must be unique in the API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/LoggerContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/loggers" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/loggers" + }, + "service_namedValues": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the NamedValue." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NamedValueCreateContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "NamedValue Contract properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/namedValues" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/namedValues" + }, + "service_notifications": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Notification Name Identifier." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/service_notifications_recipientUsers_childResource" + }, + { + "$ref": "#/definitions/service_notifications_recipientEmails_childResource" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/notifications" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/notifications" + }, + "service_notifications_recipientEmails": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "description": "Email identifier." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/notifications/recipientEmails" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/notifications/recipientEmails" + }, + "service_notifications_recipientUsers": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "User identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/notifications/recipientUsers" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/notifications/recipientUsers" + }, + "service_openidConnectProviders": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the OpenID Connect Provider." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/OpenidConnectProviderContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "OpenID Connect Providers Contract." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/openidConnectProviders" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/openidConnectProviders" + }, + "service_policies": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/policy$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The identifier of the Policy." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PolicyContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Policy contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/policies" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/policies" + }, + "service_portalRevisions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 256, + "description": "Portal revision identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PortalRevisionContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/portalRevisions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/portalRevisions" + }, + "service_portalsettings": { + "type": "object", + "oneOf": [ + { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/signin$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PortalSigninSettingProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sign-in settings contract properties." + } + }, + "required": [ + "name", + "properties" + ], + "description": "Microsoft.ApiManagement/service/portalsettings" + }, + { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/signup$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PortalSignupSettingsProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sign-up settings contract properties." + } + }, + "required": [ + "name", + "properties" + ], + "description": "Microsoft.ApiManagement/service/portalsettings" + }, + { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/delegation$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PortalDelegationSettingsProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Delegation settings contract properties." + } + }, + "required": [ + "name", + "properties" + ], + "description": "Microsoft.ApiManagement/service/portalsettings" + } + ], + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/portalsettings" + ] + } + }, + "required": [ + "apiVersion", + "type" + ], + "description": "Microsoft.ApiManagement/service/portalsettings" + }, + "service_privateEndpointConnections": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "id": { + "type": "string", + "description": "Private Endpoint Connection Resource Id." + }, + "name": { + "type": "string", + "description": "Name of the private endpoint connection." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpointConnectionRequestProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The connection state of the private endpoint connection." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/privateEndpointConnections" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/privateEndpointConnections" + }, + "service_products": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 256, + "description": "Product identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ProductContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Product profile." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/service_products_tags_childResource" + }, + { + "$ref": "#/definitions/service_products_apis_childResource" + }, + { + "$ref": "#/definitions/service_products_groups_childResource" + }, + { + "$ref": "#/definitions/service_products_policies_childResource" + } + ] + } + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/products" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/products" + }, + "service_products_apis": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/products/apis" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/products/apis" + }, + "service_products_groups": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 256, + "description": "Group identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/products/groups" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/products/groups" + }, + "service_products_policies": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/policy$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The identifier of the Policy." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PolicyContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Policy contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/products/policies" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/products/policies" + }, + "service_products_tags": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/products/tags" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/products/tags" + }, + "service_subscriptions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SubscriptionCreateParameterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the Create subscription operation." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/subscriptions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/subscriptions" + }, + "service_tags": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/TagContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/tags" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/tags" + }, + "service_templates": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Email Template Name Identifier." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EmailTemplateUpdateParameterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Email Template Update Contract properties." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/templates" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/templates" + }, + "service_tenant": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "access", + "gitAccess" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The identifier of the Access configuration." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AccessInformationCreateParameterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tenant access information update parameters of the API Management service" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/tenant" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/tenant" + }, + "service_users": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "User identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/UserCreateParameterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the Create User operation." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ApiManagement/service/users" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/users" + } + }, + "definitions": { + "AccessInformationCreateParameterProperties": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Determines whether direct access is enabled." + }, + "primaryKey": { + "type": "string", + "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + }, + "principalId": { + "type": "string", + "description": "Principal (User) Identifier." + }, + "secondaryKey": { + "type": "string", + "description": "Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + } + }, + "description": "Tenant access information update parameters of the API Management service" + }, + "AdditionalLocation": { + "type": "object", + "properties": { + "disableGateway": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "type": "string", + "description": "The location name of the additional region among Azure Data center regions." + }, + "publicIpAddressId": { + "type": "string", + "description": "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": { + "oneOf": [ + { + "$ref": "#/definitions/ApiManagementServiceSkuProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API Management service resource SKU properties." + }, + "virtualNetworkConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualNetworkConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Configuration of a virtual network to which API Management service is deployed." + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of availability zones denoting where the resource needs to come from." + } + }, + "required": [ + "location", + "sku" + ], + "description": "Description of an additional API Management resource location." + }, + "ApiContactInformation": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "The email address of the contact person/organization. MUST be in the format of an email address" + }, + "name": { + "type": "string", + "description": "The identifying name of the contact person/organization" + }, + "url": { + "type": "string", + "description": "The URL pointing to the contact information. MUST be in the format of a URL" + } + }, + "description": "API contact information" + }, + "ApiCreateOrUpdateProperties": { + "type": "object", + "properties": { + "apiRevision": { + "type": "string", + "minLength": 1, + "maxLength": 100, + "description": "Describes the revision of the API. If no value is provided, default revision 1 is created" + }, + "apiRevisionDescription": { + "type": "string", + "maxLength": 256, + "description": "Description of the API Revision." + }, + "apiType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "http", + "soap", + "websocket", + "graphql" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of API to create. \n * `http` creates a REST API \n * `soap` creates a SOAP pass-through API \n * `websocket` creates websocket API \n * `graphql` creates GraphQL API." + }, + "apiVersion": { + "type": "string", + "maxLength": 100, + "description": "Indicates the version identifier of the API if the API is versioned" + }, + "apiVersionDescription": { + "type": "string", + "maxLength": 256, + "description": "Description of the API Version." + }, + "apiVersionSet": { + "oneOf": [ + { + "$ref": "#/definitions/ApiVersionSetContractDetails" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "An API Version Set contains the common configuration for a set of API Versions relating " + }, + "apiVersionSetId": { + "type": "string", + "description": "A resource identifier for the related ApiVersionSet." + }, + "authenticationSettings": { + "oneOf": [ + { + "$ref": "#/definitions/AuthenticationSettingsContract" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API Authentication Settings." + }, + "contact": { + "oneOf": [ + { + "$ref": "#/definitions/ApiContactInformation" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API contact information" + }, + "description": { + "type": "string", + "description": "Description of the API. May include HTML formatting tags." + }, + "displayName": { + "type": "string", + "minLength": 1, + "maxLength": 300, + "description": "API name. Must be 1 to 300 characters long." + }, + "format": { + "oneOf": [ + { + "type": "string", + "enum": [ + "wadl-xml", + "wadl-link-json", + "swagger-json", + "swagger-link-json", + "wsdl", + "wsdl-link", + "openapi", + "openapi+json", + "openapi-link", + "openapi+json-link", + "graphql-link" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Format of the Content in which the API is getting imported." + }, + "isCurrent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if API revision is current api revision." + }, + "license": { + "oneOf": [ + { + "$ref": "#/definitions/ApiLicenseInformation" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API license information" + }, + "path": { + "type": "string", + "minLength": 0, + "maxLength": 400, + "description": "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": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "http", + "https", + "ws", + "wss" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes on which protocols the operations in this API can be invoked." + }, + "serviceUrl": { + "type": "string", + "minLength": 0, + "maxLength": 2000, + "description": "Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long." + }, + "sourceApiId": { + "type": "string", + "description": "API identifier of the source API." + }, + "subscriptionKeyParameterNames": { + "oneOf": [ + { + "$ref": "#/definitions/SubscriptionKeyParameterNamesContract" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Subscription key parameter names details." + }, + "subscriptionRequired": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether an API or Product subscription is required for accessing the API." + }, + "termsOfServiceUrl": { + "type": "string", + "description": " A URL to the Terms of Service for the API. MUST be in the format of a URL." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "http", + "soap", + "websocket", + "graphql" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of API." + }, + "value": { + "type": "string", + "description": "Content value when Importing an API." + }, + "wsdlSelector": { + "oneOf": [ + { + "$ref": "#/definitions/ApiCreateOrUpdatePropertiesWsdlSelector" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Criteria to limit import of WSDL to a subset of the document." + } + }, + "required": [ + "path" + ], + "description": "API Create or Update Properties." + }, + "ApiCreateOrUpdatePropertiesWsdlSelector": { + "type": "object", + "properties": { + "wsdlEndpointName": { + "type": "string", + "description": "Name of endpoint(port) to import from WSDL" + }, + "wsdlServiceName": { + "type": "string", + "description": "Name of service to import from WSDL" + } + }, + "description": "Criteria to limit import of WSDL to a subset of the document." + }, + "ApiLicenseInformation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The license name used for the API" + }, + "url": { + "type": "string", + "description": "A URL to the license used for the API. MUST be in the format of a URL" + } + }, + "description": "API license information" + }, + "ApiManagementServiceIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "required": [ + "type" + ], + "description": "Identity properties of the Api Management service resource." + }, + "ApiManagementServiceProperties": { + "type": "object", + "properties": { + "additionalLocations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalLocation" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Additional datacenter locations of the API Management service." + }, + "apiVersionConstraint": { + "oneOf": [ + { + "$ref": "#/definitions/ApiVersionConstraint" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Control Plane Apis version constraint for the API Management service." + }, + "certificates": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10." + }, + "customProperties": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384" + }, + "disableGateway": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region." + }, + "enableClientCertificate": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/HostnameConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Custom hostname configuration of the API Management service." + }, + "notificationSenderEmail": { + "type": "string", + "maxLength": 100, + "description": "Email address from which the notification will be sent." + }, + "privateEndpointConnections": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/RemotePrivateEndpointConnectionWrapper" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Private Endpoint Connections of this service." + }, + "publicIpAddressId": { + "type": "string", + "description": "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": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "type": "string", + "maxLength": 100, + "description": "Publisher email." + }, + "publisherName": { + "type": "string", + "maxLength": 100, + "description": "Publisher name." + }, + "restore": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualNetworkConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Configuration of a virtual network to which API Management service is deployed." + }, + "virtualNetworkType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "External", + "Internal" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "required": [ + "publisherEmail", + "publisherName" + ], + "description": "Properties of an API Management service resource description." + }, + "ApiManagementServiceSkuProperties": { + "type": "object", + "properties": { + "capacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0." + }, + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Developer", + "Standard", + "Premium", + "Basic", + "Consumption", + "Isolated" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Name of the Sku." + } + }, + "required": [ + "capacity", + "name" + ], + "description": "API Management service resource SKU properties." + }, + "ApiReleaseContractProperties": { + "type": "object", + "properties": { + "apiId": { + "type": "string", + "description": "Identifier of the API the release belongs to." + }, + "notes": { + "type": "string", + "description": "Release Notes" + } + }, + "description": "API Release details" + }, + "ApiVersionConstraint": { + "type": "object", + "properties": { + "minApiVersion": { + "type": "string", + "description": "Limit control plane API calls to API Management service with version equal to or newer than this value." + } + }, + "description": "Control Plane Apis version constraint for the API Management service." + }, + "ApiVersionSetContractDetails": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of API Version Set." + }, + "id": { + "type": "string", + "description": "Identifier for existing API Version Set. Omit this value to create a new Version Set." + }, + "name": { + "type": "string", + "description": "The display Name of the API Version Set." + }, + "versionHeaderName": { + "type": "string", + "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`." + }, + "versioningScheme": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Segment", + "Query", + "Header" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "An value that determines where the API Version identifier will be located in a HTTP request." + }, + "versionQueryName": { + "type": "string", + "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`." + } + }, + "description": "An API Version Set contains the common configuration for a set of API Versions relating " + }, + "ApiVersionSetContractProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of API Version Set." + }, + "displayName": { + "type": "string", + "minLength": 1, + "maxLength": 100, + "description": "Name of API Version Set" + }, + "versionHeaderName": { + "type": "string", + "minLength": 1, + "maxLength": 100, + "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`." + }, + "versioningScheme": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Segment", + "Query", + "Header" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "An value that determines where the API Version identifier will be located in a HTTP request." + }, + "versionQueryName": { + "type": "string", + "minLength": 1, + "maxLength": 100, + "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`." + } + }, + "required": [ + "displayName", + "versioningScheme" + ], + "description": "Properties of an API Version Set." + }, + "ArmIdWrapper": { + "type": "object", + "properties": {}, + "description": "A wrapper for an ARM resource id" + }, + "AssociationContractProperties": { + "type": "object", + "properties": { + "provisioningState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "created" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Provisioning state." + } + }, + "description": "Association entity contract properties." + }, + "AuthenticationSettingsContract": { + "type": "object", + "properties": { + "oAuth2": { + "oneOf": [ + { + "$ref": "#/definitions/OAuth2AuthenticationSettingsContract" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API OAuth2 Authentication settings details." + }, + "openid": { + "oneOf": [ + { + "$ref": "#/definitions/OpenIdAuthenticationSettingsContract" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API OAuth2 Authentication settings details." + } + }, + "description": "API Authentication Settings." + }, + "AuthorizationServerContractProperties": { + "type": "object", + "properties": { + "authorizationEndpoint": { + "type": "string", + "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." + }, + "authorizationMethods": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "HEAD", + "OPTIONS", + "TRACE", + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional." + }, + "bearerTokenSendingMethods": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "authorizationHeader", + "query" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the mechanism by which access token is passed to the API. " + }, + "clientAuthenticationMethod": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Basic", + "Body" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format." + }, + "clientId": { + "type": "string", + "description": "Client or app id registered with this authorization server." + }, + "clientRegistrationEndpoint": { + "type": "string", + "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." + }, + "clientSecret": { + "type": "string", + "description": "Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + }, + "defaultScope": { + "type": "string", + "description": "Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values." + }, + "description": { + "type": "string", + "description": "Description of the authorization server. Can contain HTML formatting tags." + }, + "displayName": { + "type": "string", + "minLength": 1, + "maxLength": 50, + "description": "User-friendly authorization server name." + }, + "grantTypes": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "authorizationCode", + "implicit", + "resourceOwnerPassword", + "clientCredentials" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Form of an authorization grant, which the client uses to request the access token." + }, + "resourceOwnerPassword": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." + }, + "resourceOwnerUsername": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." + }, + "supportState": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security." + }, + "tokenBodyParameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/TokenBodyParameterContract" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {\"name\" : \"name value\", \"value\": \"a value\"}." + }, + "tokenEndpoint": { + "type": "string", + "description": "OAuth token endpoint. Contains absolute URI to entity being referenced." + } + }, + "required": [ + "authorizationEndpoint", + "clientId", + "clientRegistrationEndpoint", + "displayName", + "grantTypes" + ], + "description": "External OAuth authorization server settings Properties." + }, + "BackendAuthorizationHeaderCredentials": { + "type": "object", + "properties": { + "parameter": { + "type": "string", + "minLength": 1, + "maxLength": 300, + "description": "Authentication Parameter value." + }, + "scheme": { + "type": "string", + "minLength": 1, + "maxLength": 100, + "description": "Authentication Scheme name." + } + }, + "required": [ + "parameter", + "scheme" + ], + "description": "Authorization header information." + }, + "BackendContractProperties": { + "type": "object", + "properties": { + "credentials": { + "oneOf": [ + { + "$ref": "#/definitions/BackendCredentialsContract" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Details of the Credentials used to connect to Backend." + }, + "description": { + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Backend Description." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/BackendProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties specific to the Backend Type." + }, + "protocol": { + "oneOf": [ + { + "type": "string", + "enum": [ + "http", + "soap" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Backend communication protocol." + }, + "proxy": { + "oneOf": [ + { + "$ref": "#/definitions/BackendProxyContract" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Details of the Backend WebProxy Server to use in the Request to Backend." + }, + "resourceId": { + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "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": { + "type": "string", + "minLength": 1, + "maxLength": 300, + "description": "Backend Title." + }, + "tls": { + "oneOf": [ + { + "$ref": "#/definitions/BackendTlsProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties controlling TLS Certificate Validation." + }, + "url": { + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Runtime Url of the Backend." + } + }, + "required": [ + "protocol", + "url" + ], + "description": "Parameters supplied to the Create Backend operation." + }, + "BackendCredentialsContract": { + "type": "object", + "properties": { + "authorization": { + "oneOf": [ + { + "$ref": "#/definitions/BackendAuthorizationHeaderCredentials" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Authorization header information." + }, + "certificate": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided." + }, + "certificateIds": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Client Certificate Ids." + }, + "header": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Header Parameter description." + }, + "query": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Query Parameter description." + } + }, + "description": "Details of the Credentials used to connect to Backend." + }, + "BackendProperties": { + "type": "object", + "properties": { + "serviceFabricCluster": { + "oneOf": [ + { + "$ref": "#/definitions/BackendServiceFabricClusterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the Service Fabric Type Backend." + } + }, + "description": "Properties specific to the Backend Type." + }, + "BackendProxyContract": { + "type": "object", + "properties": { + "password": { + "type": "string", + "description": "Password to connect to the WebProxy Server" + }, + "url": { + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings." + }, + "username": { + "type": "string", + "description": "Username to connect to the WebProxy server" + } + }, + "required": [ + "url" + ], + "description": "Details of the Backend WebProxy Server to use in the Request to Backend." + }, + "BackendServiceFabricClusterProperties": { + "type": "object", + "properties": { + "clientCertificateId": { + "type": "string", + "description": "The client certificate id for the management endpoint." + }, + "clientCertificatethumbprint": { + "type": "string", + "description": "The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided" + }, + "managementEndpoints": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The cluster management endpoint." + }, + "maxPartitionResolutionRetries": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Maximum number of retries while attempting resolve the partition." + }, + "serverCertificateThumbprints": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Thumbprints of certificates cluster management service uses for tls communication" + }, + "serverX509Names": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/X509CertificateName" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Server X509 Certificate Names Collection" + } + }, + "required": [ + "managementEndpoints" + ], + "description": "Properties of the Service Fabric Type Backend." + }, + "BackendTlsProperties": { + "type": "object", + "properties": { + "validateCertificateChain": { + "oneOf": [ + { + "type": "boolean", + "default": true + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host." + }, + "validateCertificateName": { + "oneOf": [ + { + "type": "boolean", + "default": true + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host." + } + }, + "description": "Properties controlling TLS Certificate Validation." + }, + "BodyDiagnosticSettings": { + "type": "object", + "properties": { + "bytes": { + "oneOf": [ + { + "type": "integer", + "maximum": 8192 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Number of request body bytes to log." + } + }, + "description": "Body logging settings." + }, + "CacheContractProperties": { + "type": "object", + "properties": { + "connectionString": { + "type": "string", + "maxLength": 300, + "description": "Runtime connection string to cache" + }, + "description": { + "type": "string", + "maxLength": 2000, + "description": "Cache description" + }, + "resourceId": { + "type": "string", + "maxLength": 2000, + "description": "Original uri of entity in external system cache points to" + }, + "useFromLocation": { + "type": "string", + "maxLength": 256, + "description": "Location identifier to use cache from (should be either 'default' or valid Azure region identifier)" + } + }, + "required": [ + "connectionString", + "useFromLocation" + ], + "description": "Properties of the Cache contract." + }, + "CertificateConfiguration": { + "type": "object", + "properties": { + "certificate": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateInformation" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSL certificate information." + }, + "certificatePassword": { + "type": "string", + "description": "Certificate Password." + }, + "encodedCertificate": { + "type": "string", + "description": "Base64 Encoded certificate." + }, + "storeName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "CertificateAuthority", + "Root" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations." + } + }, + "required": [ + "storeName" + ], + "description": "Certificate configuration which consist of non-trusted intermediates and root certificates." + }, + "CertificateCreateOrUpdateProperties": { + "type": "object", + "properties": { + "data": { + "type": "string", + "description": "Base 64 encoded certificate using the application/x-pkcs12 representation." + }, + "keyVault": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultContractCreateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Create keyVault contract details." + }, + "password": { + "type": "string", + "description": "Password for the Certificate" + } + }, + "description": "Parameters supplied to the CreateOrUpdate certificate operation." + }, + "CertificateInformation": { + "type": "object", + "properties": { + "expiry": { + "type": "string", + "format": "date-time", + "description": "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": { + "type": "string", + "description": "Subject of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + } + }, + "required": [ + "expiry", + "subject", + "thumbprint" + ], + "description": "SSL certificate information." + }, + "DataMasking": { + "type": "object", + "properties": { + "headers": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DataMaskingEntity" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Masking settings for headers" + }, + "queryParams": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DataMaskingEntity" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Masking settings for Url query parameters" + } + } + }, + "DataMaskingEntity": { + "type": "object", + "properties": { + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Mask", + "Hide" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data masking mode." + }, + "value": { + "type": "string", + "description": "The name of an entity to mask (e.g. a name of a header or a query parameter)." + } + } + }, + "DiagnosticContractProperties": { + "type": "object", + "properties": { + "alwaysLog": { + "oneOf": [ + { + "type": "string", + "enum": [ + "allErrors" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies for what type of messages sampling settings should not apply." + }, + "backend": { + "oneOf": [ + { + "$ref": "#/definitions/PipelineDiagnosticSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." + }, + "frontend": { + "oneOf": [ + { + "$ref": "#/definitions/PipelineDiagnosticSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." + }, + "httpCorrelationProtocol": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "Legacy", + "W3C" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sets correlation protocol to use for Application Insights diagnostics." + }, + "logClientIp": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Log the ClientIP. Default is false." + }, + "loggerId": { + "type": "string", + "description": "Resource Id of a target logger." + }, + "operationNameFormat": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Name", + "Url" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The format of the Operation Name for Application Insights telemetries. Default is Name." + }, + "sampling": { + "oneOf": [ + { + "$ref": "#/definitions/SamplingSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sampling settings for Diagnostic." + }, + "verbosity": { + "oneOf": [ + { + "type": "string", + "enum": [ + "verbose", + "information", + "error" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The verbosity level applied to traces emitted by trace policies." + } + }, + "required": [ + "loggerId" + ], + "description": "Diagnostic Entity Properties" + }, + "EmailTemplateParametersContractProperties": { + "type": "object", + "properties": { + "description": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9-._]+$", + "minLength": 1, + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Template parameter description." + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9-._]+$", + "minLength": 1, + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Template parameter name." + }, + "title": { + "type": "string", + "minLength": 1, + "maxLength": 4096, + "description": "Template parameter title." + } + }, + "description": "Email Template Parameter contract." + }, + "EmailTemplateUpdateParameterProperties": { + "type": "object", + "properties": { + "body": { + "type": "string", + "minLength": 1, + "description": "Email Template Body. This should be a valid XDocument" + }, + "description": { + "type": "string", + "description": "Description of the Email Template." + }, + "parameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EmailTemplateParametersContractProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Email Template Parameter values." + }, + "subject": { + "type": "string", + "minLength": 1, + "maxLength": 1000, + "description": "Subject of the Template." + }, + "title": { + "type": "string", + "description": "Title of the Template." + } + }, + "description": "Email Template Update Contract properties." + }, + "GatewayCertificateAuthorityContractProperties": { + "type": "object", + "properties": { + "isTrusted": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Determines whether certificate authority is trusted." + } + }, + "description": "Gateway certificate authority details." + }, + "GatewayContractProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "maxLength": 1000, + "description": "Gateway description" + }, + "locationData": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceLocationDataContract" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource location data properties." + } + }, + "description": "Properties of the Gateway contract." + }, + "GatewayHostnameConfigurationContractProperties": { + "type": "object", + "properties": { + "certificateId": { + "type": "string", + "description": "Identifier of Certificate entity that will be used for TLS connection establishment" + }, + "hostname": { + "type": "string", + "description": "Hostname value. Supports valid domain name, partial or full wildcard" + }, + "http2Enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies if HTTP/2.0 is supported" + }, + "negotiateClientCertificate": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Determines whether gateway requests client certificate" + }, + "tls10Enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies if TLS 1.0 is supported" + }, + "tls11Enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies if TLS 1.1 is supported" + } + }, + "description": "Gateway hostname configuration details." + }, + "GroupCreateParametersProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Group description." + }, + "displayName": { + "type": "string", + "minLength": 1, + "maxLength": 300, + "description": "Group name." + }, + "externalId": { + "type": "string", + "description": "Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "custom", + "system", + "external" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Group type." + } + }, + "required": [ + "displayName" + ], + "description": "Parameters supplied to the Create Group operation." + }, + "HostnameConfiguration": { + "type": "object", + "properties": { + "certificate": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateInformation" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSL certificate information." + }, + "certificatePassword": { + "type": "string", + "description": "Certificate Password." + }, + "certificateSource": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Managed", + "KeyVault", + "Custom", + "BuiltIn" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Certificate Source." + }, + "certificateStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Completed", + "Failed", + "InProgress" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Certificate Status." + }, + "defaultSslBinding": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "type": "string", + "description": "Base64 Encoded certificate." + }, + "hostName": { + "type": "string", + "description": "Hostname to configure on the Api Management service." + }, + "identityClientId": { + "type": "string", + "description": "System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate." + }, + "keyVaultId": { + "type": "string", + "description": "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": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specify true to always negotiate client certificate on the hostname. Default Value is false." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Proxy", + "Portal", + "Management", + "Scm", + "DeveloperPortal" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Hostname type." + } + }, + "required": [ + "hostName", + "type" + ], + "description": "Custom hostname configuration." + }, + "HttpMessageDiagnostic": { + "type": "object", + "properties": { + "body": { + "oneOf": [ + { + "$ref": "#/definitions/BodyDiagnosticSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Body logging settings." + }, + "dataMasking": { + "oneOf": [ + { + "$ref": "#/definitions/DataMasking" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "headers": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Array of HTTP Headers to log." + } + }, + "description": "Http message diagnostic settings." + }, + "IdentityProviderCreateContractProperties": { + "type": "object", + "properties": { + "allowedTenants": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Allowed Tenants when configuring Azure Active Directory login." + }, + "authority": { + "type": "string", + "description": "OpenID Connect discovery endpoint hostname for AAD or AAD B2C." + }, + "clientId": { + "type": "string", + "minLength": 1, + "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft." + }, + "clientSecret": { + "type": "string", + "minLength": 1, + "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + }, + "passwordResetPolicyName": { + "type": "string", + "minLength": 1, + "description": "Password Reset Policy Name. Only applies to AAD B2C Identity Provider." + }, + "profileEditingPolicyName": { + "type": "string", + "minLength": 1, + "description": "Profile Editing Policy Name. Only applies to AAD B2C Identity Provider." + }, + "signinPolicyName": { + "type": "string", + "minLength": 1, + "description": "Signin Policy Name. Only applies to AAD B2C Identity Provider." + }, + "signinTenant": { + "type": "string", + "description": "The TenantId to use instead of Common when logging into Active Directory" + }, + "signupPolicyName": { + "type": "string", + "minLength": 1, + "description": "Signup Policy Name. Only applies to AAD B2C Identity Provider." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity Provider Type identifier." + } + }, + "required": [ + "clientId", + "clientSecret" + ], + "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users." + }, + "IssueAttachmentContractProperties": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "An HTTP link or Base64-encoded binary data." + }, + "contentFormat": { + "type": "string", + "description": "Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property." + }, + "title": { + "type": "string", + "description": "Filename by which the binary data will be saved." + } + }, + "required": [ + "content", + "contentFormat", + "title" + ], + "description": "Issue Attachment contract Properties." + }, + "IssueCommentContractProperties": { + "type": "object", + "properties": { + "createdDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the comment was created." + }, + "text": { + "type": "string", + "description": "Comment text." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user who left the comment." + } + }, + "required": [ + "text", + "userId" + ], + "description": "Issue Comment contract Properties." + }, + "IssueContractProperties": { + "type": "object", + "properties": { + "apiId": { + "type": "string", + "description": "A resource identifier for the API the issue was created for." + }, + "createdDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the issue was created." + }, + "description": { + "type": "string", + "description": "Text describing the issue." + }, + "state": { + "oneOf": [ + { + "type": "string", + "enum": [ + "proposed", + "open", + "removed", + "resolved", + "closed" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Status of the issue." + }, + "title": { + "type": "string", + "description": "The issue title." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user created the issue." + } + }, + "required": [ + "description", + "title", + "userId" + ], + "description": "Issue contract Properties." + }, + "KeyVaultContractCreateProperties": { + "type": "object", + "properties": { + "identityClientId": { + "type": "string", + "description": "SystemAssignedIdentity or UserAssignedIdentity Client Id which will be used to access key vault secret." + }, + "secretIdentifier": { + "type": "string", + "description": "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" + } + }, + "description": "Create keyVault contract details." + }, + "LoggerContractProperties": { + "type": "object", + "properties": { + "credentials": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger." + }, + "description": { + "type": "string", + "maxLength": 256, + "description": "Logger description." + }, + "isBuffered": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." + }, + "loggerType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "azureEventHub", + "applicationInsights", + "azureMonitor" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Logger type." + }, + "resourceId": { + "type": "string", + "description": "Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource)." + } + }, + "required": [ + "loggerType" + ], + "description": "The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs." + }, + "NamedValueCreateContractProperties": { + "type": "object", + "properties": { + "displayName": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9-._]+$", + "minLength": 1, + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters." + }, + "keyVault": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultContractCreateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Create keyVault contract details." + }, + "secret": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Determines whether the value is a secret and should be encrypted or not. Default value is false." + }, + "tags": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Optional tags that when provided can be used to filter the NamedValue list." + }, + "value": { + "type": "string", + "maxLength": 4096, + "description": "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." + } + }, + "required": [ + "displayName" + ], + "description": "NamedValue Contract properties." + }, + "OAuth2AuthenticationSettingsContract": { + "type": "object", + "properties": { + "authorizationServerId": { + "type": "string", + "description": "OAuth authorization server identifier." + }, + "scope": { + "type": "string", + "description": "operations scope." + } + }, + "description": "API OAuth2 Authentication settings details." + }, + "OpenIdAuthenticationSettingsContract": { + "type": "object", + "properties": { + "bearerTokenSendingMethods": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "authorizationHeader", + "query" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "How to send token to the server." + }, + "openidProviderId": { + "type": "string", + "description": "OAuth authorization server identifier." + } + }, + "description": "API OAuth2 Authentication settings details." + }, + "OpenidConnectProviderContractProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "Client ID of developer console which is the client application." + }, + "clientSecret": { + "type": "string", + "description": "Client Secret of developer console which is the client application." + }, + "description": { + "type": "string", + "description": "User-friendly description of OpenID Connect Provider." + }, + "displayName": { + "type": "string", + "maxLength": 50, + "description": "User-friendly OpenID Connect Provider name." + }, + "metadataEndpoint": { + "type": "string", + "description": "Metadata endpoint URI." + } + }, + "required": [ + "clientId", + "displayName", + "metadataEndpoint" + ], + "description": "OpenID Connect Providers Contract." + }, + "OperationContractProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "maxLength": 1000, + "description": "Description of the operation. May include HTML formatting tags." + }, + "displayName": { + "type": "string", + "minLength": 1, + "maxLength": 300, + "description": "Operation Name." + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them." + }, + "policies": { + "type": "string", + "description": "Operation Policies" + }, + "request": { + "oneOf": [ + { + "$ref": "#/definitions/RequestContract" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Operation request details." + }, + "responses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ResponseContract" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Array of Operation responses." + }, + "templateParameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of URL template parameters." + }, + "urlTemplate": { + "type": "string", + "minLength": 1, + "maxLength": 1000, + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}" + } + }, + "required": [ + "displayName", + "method", + "urlTemplate" + ], + "description": "Operation Contract Properties" + }, + "ParameterContract": { + "type": "object", + "properties": { + "defaultValue": { + "type": "string", + "description": "Default parameter value." + }, + "description": { + "type": "string", + "description": "Parameter description." + }, + "examples": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ParameterExampleContract" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameter examples." + }, + "name": { + "type": "string", + "description": "Parameter name." + }, + "required": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether parameter is required or not." + }, + "schemaId": { + "type": "string", + "description": "Schema identifier." + }, + "type": { + "type": "string", + "description": "Parameter type." + }, + "typeName": { + "type": "string", + "description": "Type name defined by the schema." + }, + "values": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameter values." + } + }, + "required": [ + "name", + "type" + ], + "description": "Operation parameters details." + }, + "ParameterExampleContract": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Long description for the example" + }, + "externalValue": { + "type": "string", + "description": "A URL that points to the literal example" + }, + "summary": { + "type": "string", + "description": "Short description for the example" + }, + "value": { + "type": "object", + "properties": {}, + "description": "Example value. May be a primitive value, or an object." + } + }, + "description": "Parameter example." + }, + "PipelineDiagnosticSettings": { + "type": "object", + "properties": { + "request": { + "oneOf": [ + { + "$ref": "#/definitions/HttpMessageDiagnostic" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Http message diagnostic settings." + }, + "response": { + "oneOf": [ + { + "$ref": "#/definitions/HttpMessageDiagnostic" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Http message diagnostic settings." + } + }, + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." + }, + "PolicyContractProperties": { + "type": "object", + "properties": { + "format": { + "oneOf": [ + { + "type": "string", + "enum": [ + "xml", + "xml-link", + "rawxml", + "rawxml-link" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Format of the policyContent." + }, + "value": { + "type": "string", + "description": "Contents of the Policy as defined by the format." + } + }, + "required": [ + "value" + ], + "description": "Policy contract Properties." + }, + "PortalDelegationSettingsProperties": { + "type": "object", + "properties": { + "subscriptions": { + "oneOf": [ + { + "$ref": "#/definitions/SubscriptionsDelegationSettingsProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Subscriptions delegation settings properties." + }, + "url": { + "type": "string", + "description": "A delegation Url." + }, + "userRegistration": { + "oneOf": [ + { + "$ref": "#/definitions/RegistrationDelegationSettingsProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "User registration delegation settings properties." + }, + "validationKey": { + "type": "string", + "description": "A base64-encoded validation key to validate, that a request is coming from Azure API Management." + } + }, + "description": "Delegation settings contract properties." + }, + "PortalRevisionContractProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "maxLength": 2000, + "description": "Portal revision description." + }, + "isCurrent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the portal's revision is public." + } + } + }, + "PortalSigninSettingProperties": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Redirect Anonymous users to the Sign-In page." + } + }, + "description": "Sign-in settings contract properties." + }, + "PortalSignupSettingsProperties": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Allow users to sign up on a developer portal." + }, + "termsOfService": { + "oneOf": [ + { + "$ref": "#/definitions/TermsOfServiceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Terms of service contract properties." + } + }, + "description": "Sign-up settings contract properties." + }, + "PrivateEndpointConnectionRequestProperties": { + "type": "object", + "properties": { + "privateLinkServiceConnectionState": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "description": "The connection state of the private endpoint connection." + }, + "PrivateEndpointConnectionWrapperProperties": { + "type": "object", + "properties": { + "privateEndpoint": { + "oneOf": [ + { + "$ref": "#/definitions/ArmIdWrapper" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A wrapper for an ARM resource id" + }, + "privateLinkServiceConnectionState": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "properties": { + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Pending", + "Approved", + "Rejected" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "ProductContractProperties": { + "type": "object", + "properties": { + "approvalRequired": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false." + }, + "description": { + "type": "string", + "minLength": 0, + "maxLength": 1000, + "description": "Product description. May include HTML formatting tags." + }, + "displayName": { + "type": "string", + "minLength": 1, + "maxLength": 300, + "description": "Product name." + }, + "state": { + "oneOf": [ + { + "type": "string", + "enum": [ + "notPublished", + "published" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished." + }, + "subscriptionRequired": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true." + }, + "subscriptionsLimit": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + }, + "terms": { + "type": "string", + "description": "Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process." + } + }, + "required": [ + "displayName" + ], + "description": "Product profile." + }, + "RegistrationDelegationSettingsProperties": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable or disable delegation for user registration." + } + }, + "description": "User registration delegation settings properties." + }, + "RemotePrivateEndpointConnectionWrapper": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Private Endpoint connection resource id" + }, + "name": { + "type": "string", + "description": "Private Endpoint Connection Name" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpointConnectionWrapperProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "type": { + "type": "string", + "description": "Private Endpoint Connection Resource Type" + } + }, + "description": "Remote Private Endpoint Connection resource." + }, + "RepresentationContract": { + "type": "object", + "properties": { + "contentType": { + "type": "string", + "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." + }, + "examples": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ParameterExampleContract" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameter examples." + }, + "formParameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.." + }, + "schemaId": { + "type": "string", + "description": "Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." + }, + "typeName": { + "type": "string", + "description": "Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." + } + }, + "required": [ + "contentType" + ], + "description": "Operation request/response representation details." + }, + "RequestContract": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Operation request description." + }, + "headers": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of operation request headers." + }, + "queryParameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of operation request query parameters." + }, + "representations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/RepresentationContract" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of operation request representations." + } + }, + "description": "Operation request details." + }, + "ResourceLocationDataContract": { + "type": "object", + "properties": { + "city": { + "type": "string", + "maxLength": 256, + "description": "The city or locality where the resource is located." + }, + "countryOrRegion": { + "type": "string", + "maxLength": 256, + "description": "The country or region where the resource is located." + }, + "district": { + "type": "string", + "maxLength": 256, + "description": "The district, state, or province where the resource is located." + }, + "name": { + "type": "string", + "maxLength": 256, + "description": "A canonical name for the geographic or physical location." + } + }, + "required": [ + "name" + ], + "description": "Resource location data properties." + }, + "ResponseContract": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Operation response description." + }, + "headers": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of operation response headers." + }, + "representations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/RepresentationContract" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of operation response representations." + }, + "statusCode": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Operation response HTTP status code." + } + }, + "required": [ + "statusCode" + ], + "description": "Operation response details." + }, + "SamplingSettings": { + "type": "object", + "properties": { + "percentage": { + "oneOf": [ + { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Rate of sampling for fixed-rate sampling." + }, + "samplingType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "fixed" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sampling type." + } + }, + "description": "Sampling settings for Diagnostic." + }, + "SchemaContractProperties": { + "type": "object", + "properties": { + "contentType": { + "type": "string", + "description": "Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`." + }, + "document": { + "oneOf": [ + { + "$ref": "#/definitions/SchemaDocumentProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Schema Document Properties." + } + }, + "required": [ + "contentType" + ], + "description": "API Schema create or update contract Properties." + }, + "SchemaDocumentProperties": { + "type": "object", + "properties": { + "components": { + "type": "object", + "properties": {}, + "description": "Types definitions. Used for OpenAPI v3 schemas only, null otherwise." + }, + "definitions": { + "type": "object", + "properties": {}, + "description": "Types definitions. Used for OpenAPI v2 (Swagger) schemas only, null otherwise." + }, + "value": { + "type": "string", + "description": "Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI." + } + }, + "description": "Schema Document Properties." + }, + "service_apis_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApiCreateOrUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API Create or Update Properties." + }, + "type": { + "type": "string", + "enum": [ + "apis" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis" + }, + "service_apis_diagnostics_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Diagnostic identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Diagnostic Entity Properties" + }, + "type": { + "type": "string", + "enum": [ + "diagnostics" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/diagnostics" + }, + "service_apis_issues_attachments_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Attachment identifier within an Issue. Must be unique in the current Issue." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IssueAttachmentContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Issue Attachment contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "attachments" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/issues/attachments" + }, + "service_apis_issues_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Issue identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IssueContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Issue contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "issues" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/issues" + }, + "service_apis_issues_comments_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Comment identifier within an Issue. Must be unique in the current Issue." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IssueCommentContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Issue Comment contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "comments" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/issues/comments" + }, + "service_apis_operations_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Operation identifier within an API. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/OperationContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Operation Contract Properties" + }, + "type": { + "type": "string", + "enum": [ + "operations" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/operations" + }, + "service_apis_operations_policies_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "enum": [ + "policy" + ], + "description": "The identifier of the Policy." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PolicyContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Policy contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "policies" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/operations/policies" + }, + "service_apis_operations_tags_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "tags" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/operations/tags" + }, + "service_apis_policies_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "enum": [ + "policy" + ], + "description": "The identifier of the Policy." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PolicyContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Policy contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "policies" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/policies" + }, + "service_apis_releases_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Release identifier within an API. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApiReleaseContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API Release details" + }, + "type": { + "type": "string", + "enum": [ + "releases" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/releases" + }, + "service_apis_schemas_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Schema identifier within an API. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SchemaContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "API Schema create or update contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "schemas" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/schemas" + }, + "service_apis_tagDescriptions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/TagDescriptionBaseProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the Create TagDescription operation." + }, + "type": { + "type": "string", + "enum": [ + "tagDescriptions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/tagDescriptions" + }, + "service_apis_tags_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "tags" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/apis/tags" + }, + "service_apiVersionSets_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Api Version Set identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApiVersionSetContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of an API Version Set." + }, + "type": { + "type": "string", + "enum": [ + "apiVersionSets" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/apiVersionSets" + }, + "service_authorizationServers_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the authorization server." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AuthorizationServerContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "External OAuth authorization server settings Properties." + }, + "type": { + "type": "string", + "enum": [ + "authorizationServers" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/authorizationServers" + }, + "service_backends_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/BackendContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the Create Backend operation." + }, + "type": { + "type": "string", + "enum": [ + "backends" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/backends" + }, + "service_caches_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier)." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CacheContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the Cache contract." + }, + "type": { + "type": "string", + "enum": [ + "caches" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/caches" + }, + "service_certificates_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateCreateOrUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the CreateOrUpdate certificate operation." + }, + "type": { + "type": "string", + "enum": [ + "certificates" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/certificates" + }, + "service_contentTypes_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Content type identifier." + }, + "type": { + "type": "string", + "enum": [ + "contentTypes" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/contentTypes" + }, + "service_contentTypes_contentItems_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Content item identifier." + }, + "type": { + "type": "string", + "enum": [ + "contentItems" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/contentTypes/contentItems" + }, + "service_diagnostics_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Diagnostic identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Diagnostic Entity Properties" + }, + "type": { + "type": "string", + "enum": [ + "diagnostics" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/diagnostics" + }, + "service_gateways_apis_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "API identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AssociationContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Association entity contract properties." + }, + "type": { + "type": "string", + "enum": [ + "apis" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/gateways/apis" + }, + "service_gateways_certificateAuthorities_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GatewayCertificateAuthorityContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Gateway certificate authority details." + }, + "type": { + "type": "string", + "enum": [ + "certificateAuthorities" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/gateways/certificateAuthorities" + }, + "service_gateways_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GatewayContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the Gateway contract." + }, + "type": { + "type": "string", + "enum": [ + "gateways" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/gateways" + }, + "service_gateways_hostnameConfigurations_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GatewayHostnameConfigurationContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Gateway hostname configuration details." + }, + "type": { + "type": "string", + "enum": [ + "hostnameConfigurations" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations" + }, + "service_groups_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 256, + "description": "Group identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GroupCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the Create Group operation." + }, + "type": { + "type": "string", + "enum": [ + "groups" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/groups" + }, + "service_groups_users_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "User identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "users" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/groups/users" + }, + "service_identityProviders_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity Provider Type identifier." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IdentityProviderCreateContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users." + }, + "type": { + "type": "string", + "enum": [ + "identityProviders" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/identityProviders" + }, + "service_loggers_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Logger identifier. Must be unique in the API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/LoggerContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs." + }, + "type": { + "type": "string", + "enum": [ + "loggers" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/loggers" + }, + "service_namedValues_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the NamedValue." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NamedValueCreateContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "NamedValue Contract properties." + }, + "type": { + "type": "string", + "enum": [ + "namedValues" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/namedValues" + }, + "service_notifications_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Notification Name Identifier." + }, + "type": { + "type": "string", + "enum": [ + "notifications" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/notifications" + }, + "service_notifications_recipientEmails_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "description": "Email identifier." + }, + "type": { + "type": "string", + "enum": [ + "recipientEmails" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/notifications/recipientEmails" + }, + "service_notifications_recipientUsers_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "User identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "recipientUsers" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/notifications/recipientUsers" + }, + "service_openidConnectProviders_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identifier of the OpenID Connect Provider." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/OpenidConnectProviderContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "OpenID Connect Providers Contract." + }, + "type": { + "type": "string", + "enum": [ + "openidConnectProviders" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/openidConnectProviders" + }, + "service_policies_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "enum": [ + "policy" + ], + "description": "The identifier of the Policy." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PolicyContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Policy contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "policies" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/policies" + }, + "service_portalRevisions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 256, + "description": "Portal revision identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PortalRevisionContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "portalRevisions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/portalRevisions" + }, + "service_portalsettings_childResource": { + "type": "object", + "oneOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "signin" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PortalSigninSettingProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sign-in settings contract properties." + } + }, + "required": [ + "name", + "properties" + ], + "description": "Microsoft.ApiManagement/service/portalsettings" + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "signup" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PortalSignupSettingsProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sign-up settings contract properties." + } + }, + "required": [ + "name", + "properties" + ], + "description": "Microsoft.ApiManagement/service/portalsettings" + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "delegation" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PortalDelegationSettingsProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Delegation settings contract properties." + } + }, + "required": [ + "name", + "properties" + ], + "description": "Microsoft.ApiManagement/service/portalsettings" + } + ], + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "type": { + "type": "string", + "enum": [ + "portalsettings" + ] + } + }, + "required": [ + "apiVersion", + "type" + ], + "description": "Microsoft.ApiManagement/service/portalsettings" + }, + "service_privateEndpointConnections_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "id": { + "type": "string", + "description": "Private Endpoint Connection Resource Id." + }, + "name": { + "type": "string", + "description": "Name of the private endpoint connection." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpointConnectionRequestProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The connection state of the private endpoint connection." + }, + "type": { + "type": "string", + "enum": [ + "privateEndpointConnections" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/privateEndpointConnections" + }, + "service_products_apis_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number." + }, + "type": { + "type": "string", + "enum": [ + "apis" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/products/apis" + }, + "service_products_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 256, + "description": "Product identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ProductContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Product profile." + }, + "type": { + "type": "string", + "enum": [ + "products" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/products" + }, + "service_products_groups_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 256, + "description": "Group identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "groups" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/products/groups" + }, + "service_products_policies_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "enum": [ + "policy" + ], + "description": "The identifier of the Policy." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PolicyContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Policy contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "policies" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/products/policies" + }, + "service_products_tags_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag identifier. Must be unique in the current API Management service instance." + }, + "type": { + "type": "string", + "enum": [ + "tags" + ] + } + }, + "required": [ + "apiVersion", + "name", + "type" + ], + "description": "Microsoft.ApiManagement/service/products/tags" + }, + "service_subscriptions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "maxLength": 256 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SubscriptionCreateParameterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the Create subscription operation." + }, + "type": { + "type": "string", + "enum": [ + "subscriptions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/subscriptions" + }, + "service_tags_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[^*#&+:<>?]+$", + "minLength": 1, + "maxLength": 80 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/TagContractProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tag contract Properties." + }, + "type": { + "type": "string", + "enum": [ + "tags" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/tags" + }, + "service_templates_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Email Template Name Identifier." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EmailTemplateUpdateParameterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Email Template Update Contract properties." + }, + "type": { + "type": "string", + "enum": [ + "templates" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/templates" + }, + "service_tenant_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "access", + "gitAccess" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The identifier of the Access configuration." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AccessInformationCreateParameterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tenant access information update parameters of the API Management service" + }, + "type": { + "type": "string", + "enum": [ + "tenant" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/tenant" + }, + "service_users_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2021-04-01-preview" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "description": "User identifier. Must be unique in the current API Management service instance." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/UserCreateParameterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Parameters supplied to the Create User operation." + }, + "type": { + "type": "string", + "enum": [ + "users" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.ApiManagement/service/users" + }, + "SubscriptionCreateParameterProperties": { + "type": "object", + "properties": { + "allowTracing": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Determines whether tracing can be enabled" + }, + "displayName": { + "type": "string", + "minLength": 1, + "maxLength": 100, + "description": "Subscription name." + }, + "ownerId": { + "type": "string", + "description": "User (user id path) for whom subscription is being created in form /users/{userId}" + }, + "primaryKey": { + "type": "string", + "minLength": 1, + "maxLength": 256, + "description": "Primary subscription key. If not specified during request key will be generated automatically." + }, + "scope": { + "type": "string", + "description": "Scope like /products/{productId} or /apis or /apis/{apiId}." + }, + "secondaryKey": { + "type": "string", + "minLength": 1, + "maxLength": 256, + "description": "Secondary subscription key. If not specified during request key will be generated automatically." + }, + "state": { + "oneOf": [ + { + "type": "string", + "enum": [ + "suspended", + "active", + "expired", + "submitted", + "rejected", + "cancelled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated." + } + }, + "required": [ + "displayName", + "scope" + ], + "description": "Parameters supplied to the Create subscription operation." + }, + "SubscriptionKeyParameterNamesContract": { + "type": "object", + "properties": { + "header": { + "type": "string", + "description": "Subscription key header name." + }, + "query": { + "type": "string", + "description": "Subscription key query string parameter name." + } + }, + "description": "Subscription key parameter names details." + }, + "SubscriptionsDelegationSettingsProperties": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable or disable delegation for subscriptions." + } + }, + "description": "Subscriptions delegation settings properties." + }, + "TagContractProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "minLength": 1, + "maxLength": 160, + "description": "Tag name." + } + }, + "required": [ + "displayName" + ], + "description": "Tag contract Properties." + }, + "TagDescriptionBaseProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the Tag." + }, + "externalDocsDescription": { + "type": "string", + "description": "Description of the external resources describing the tag." + }, + "externalDocsUrl": { + "type": "string", + "maxLength": 2000, + "description": "Absolute URL of external resources describing the tag." + } + }, + "description": "Parameters supplied to the Create TagDescription operation." + }, + "TermsOfServiceProperties": { + "type": "object", + "properties": { + "consentRequired": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Ask user for consent to the terms of service." + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Display terms of service during a sign-up process." + }, + "text": { + "type": "string", + "description": "A terms of service text." + } + }, + "description": "Terms of service contract properties." + }, + "TokenBodyParameterContract": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "body parameter name." + }, + "value": { + "type": "string", + "description": "body parameter value." + } + }, + "required": [ + "name", + "value" + ], + "description": "OAuth acquire token request body parameter (www-url-form-encoded)." + }, + "UserCreateParameterProperties": { + "type": "object", + "properties": { + "appType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "portal", + "developerPortal" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Determines the type of application which send the create user request. Default is legacy portal." + }, + "confirmation": { + "oneOf": [ + { + "type": "string", + "enum": [ + "signup", + "invite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Determines the type of confirmation e-mail that will be sent to the newly created user." + }, + "email": { + "type": "string", + "minLength": 1, + "maxLength": 254, + "description": "Email address. Must not be empty and must be unique within the service instance." + }, + "firstName": { + "type": "string", + "minLength": 1, + "maxLength": 100, + "description": "First name." + }, + "identities": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/UserIdentityContract" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of user identities." + }, + "lastName": { + "type": "string", + "minLength": 1, + "maxLength": 100, + "description": "Last name." + }, + "note": { + "type": "string", + "description": "Optional note about a user set by the administrator." + }, + "password": { + "type": "string", + "description": "User Password. If no value is provided, a default password is generated." + }, + "state": { + "oneOf": [ + { + "type": "string", + "enum": [ + "active", + "blocked", + "pending", + "deleted" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active." + } + }, + "required": [ + "email", + "firstName", + "lastName" + ], + "description": "Parameters supplied to the Create User operation." + }, + "UserIdentityContract": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier value within provider." + }, + "provider": { + "type": "string", + "description": "Identity provider name." + } + }, + "description": "User identity details." + }, + "UserIdentityProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The client id of user assigned identity." + }, + "principalId": { + "type": "string", + "description": "The principal id of user assigned identity." + } + } + }, + "VirtualNetworkConfiguration": { + "type": "object", + "properties": { + "subnetResourceId": { + "oneOf": [ + { + "type": "string", + "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in." + } + }, + "description": "Configuration of a virtual network to which API Management service is deployed." + }, + "X509CertificateName": { + "type": "object", + "properties": { + "issuerCertificateThumbprint": { + "type": "string", + "description": "Thumbprint for the Issuer of the Certificate." + }, + "name": { + "type": "string", + "description": "Common Name of the Certificate." + } + }, + "description": "Properties of server X509Names." + } + } +} \ No newline at end of file diff --git a/schemas/common/autogeneratedResources.json b/schemas/common/autogeneratedResources.json index 8be43a818b..1b780500e4 100644 --- a/schemas/common/autogeneratedResources.json +++ b/schemas/common/autogeneratedResources.json @@ -1372,6 +1372,153 @@ { "$ref": "https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_users" }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_diagnostics" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_issues" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_issues_attachments" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_issues_comments" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_operations" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_operations_policies" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_operations_tags" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_policies" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_releases" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_schemas" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_tagDescriptions" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apis_tags" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_apiVersionSets" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_authorizationServers" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_backends" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_caches" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_certificates" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_contentTypes" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_contentTypes_contentItems" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_diagnostics" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_gateways" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_gateways_apis" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_gateways_certificateAuthorities" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_gateways_hostnameConfigurations" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_groups" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_groups_users" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_identityProviders" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_loggers" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_namedValues" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_notifications" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_notifications_recipientEmails" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_notifications_recipientUsers" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_openidConnectProviders" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_policies" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_portalRevisions" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_portalsettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_privateEndpointConnections" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_products" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_products_apis" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_products_groups" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_products_policies" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_products_tags" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_subscriptions" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_tags" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_templates" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_tenant" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.ApiManagement.json#/resourceDefinitions/service_users" + }, { "$ref": "https://schema.management.azure.com/schemas/2019-02-01-preview/Microsoft.AppConfiguration.json#/resourceDefinitions/configurationStores" },