{ "swagger": "2.0", "info": { "version": "2024-05-01", "description": "A spec file containing all the definitions", "title": "Definitions file" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": {}, "definitions": { "AccessInformationCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/AccessInformationContract" }, "description": "Page values.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged AccessInformation list representation." }, "AccessInformationContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AccessInformationContractProperties", "description": "AccessInformation entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Tenant Settings." }, "AccessInformationContractProperties": { "type": "object", "properties": { "id": { "type": "string", "description": "Access Information type ('access' or 'gitAccess')" }, "principalId": { "type": "string", "description": "Principal (User) Identifier." }, "enabled": { "type": "boolean", "description": "Determines whether direct access is enabled." } }, "description": "Tenant access information contract of the API Management service." }, "AccessInformationSecretsContract": { "type": "object", "properties": { "id": { "type": "string", "description": "Access Information type ('access' or 'gitAccess')" }, "principalId": { "type": "string", "description": "Principal (User) Identifier." }, "primaryKey": { "type": "string", "x-ms-secret": true, "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." }, "secondaryKey": { "type": "string", "x-ms-secret": true, "description": "Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." }, "enabled": { "type": "boolean", "description": "Determines whether direct access is enabled." } }, "description": "Tenant access information contract of the API Management service." }, "AccessInformationCreateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AccessInformationCreateParameterProperties", "description": "Tenant access information update parameter properties." } }, "description": "Tenant access information update parameters." }, "AccessInformationCreateParameterProperties": { "type": "object", "properties": { "principalId": { "type": "string", "description": "Principal (User) Identifier." }, "primaryKey": { "type": "string", "x-ms-secret": true, "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." }, "secondaryKey": { "type": "string", "x-ms-secret": true, "description": "Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." }, "enabled": { "type": "boolean", "description": "Determines whether direct access is enabled." } }, "description": "Tenant access information update parameters of the API Management service" }, "AccessInformationUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AccessInformationUpdateParameterProperties", "description": "Tenant access information update parameter properties." } }, "description": "Tenant access information update parameters." }, "AccessInformationUpdateParameterProperties": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Determines whether direct access is enabled." } }, "description": "Tenant access information update parameters of the API Management service" }, "TenantSettingsCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/TenantSettingsContract" }, "description": "Page values.", "readOnly": true }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged AccessInformation list representation." }, "TenantSettingsContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TenantSettingsContractProperties", "description": "TenantSettings entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Tenant Settings." }, "TenantSettingsContractProperties": { "type": "object", "properties": { "settings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Tenant settings" } }, "description": "Tenant access information contract of the API Management service." }, "ApiCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApiContract" }, "description": "Page values.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged API list representation." }, "DocumentationCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/DocumentationContract" }, "x-ms-identifiers": [ "name" ], "description": "Page values.", "readOnly": true }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged Documentation list representation." }, "WikiCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/WikiContract" }, "x-ms-identifiers": [ "name" ], "description": "Page values.", "readOnly": true }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged Wiki list representation." }, "ApiContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApiContractProperties", "description": "API entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "API details." }, "ApiContractProperties": { "type": "object", "properties": { "sourceApiId": { "type": "string", "description": "API identifier of the source API." }, "displayName": { "type": "string", "description": "API name. Must be 1 to 300 characters long.", "minLength": 1, "maxLength": 300 }, "serviceUrl": { "type": "string", "description": "Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.", "minLength": 0, "maxLength": 2000 }, "path": { "type": "string", "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.", "minLength": 0, "maxLength": 400 }, "protocols": { "type": "array", "items": { "type": "string", "enum": [ "http", "https", "ws", "wss" ], "x-ms-enum": { "name": "Protocol", "modelAsString": true } }, "description": "Describes on which protocols the operations in this API can be invoked." }, "apiVersionSet": { "description": "Version set details", "$ref": "#/definitions/ApiVersionSetContractDetails" }, "provisioningState": { "type": "string", "readOnly": true, "description": "The provisioning state" } }, "allOf": [ { "$ref": "#/definitions/ApiEntityBaseContract" } ], "required": [ "path" ], "description": "API Entity Properties" }, "ApiCreateOrUpdateParameter": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApiCreateOrUpdateProperties", "description": "API entity create of update properties." } }, "description": "API Create or Update Parameters." }, "ApiCreateOrUpdateProperties": { "type": "object", "properties": { "value": { "type": "string", "description": "Content value when Importing an API." }, "format": { "type": "string", "description": "Format of the Content in which the API is getting imported. New formats can be added in the future", "enum": [ "wadl-xml", "wadl-link-json", "swagger-json", "swagger-link-json", "wsdl", "wsdl-link", "openapi", "openapi+json", "openapi-link", "openapi+json-link", "graphql-link", "odata", "odata-link", "grpc", "grpc-link" ], "x-ms-enum": { "name": "ContentFormat", "modelAsString": true, "values": [ { "value": "wadl-xml", "description": "The contents are inline and Content type is a WADL document." }, { "value": "wadl-link-json", "description": "The WADL document is hosted on a publicly accessible internet address." }, { "value": "swagger-json", "description": "The contents are inline and Content Type is a OpenAPI 2.0 JSON Document." }, { "value": "swagger-link-json", "description": "The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address." }, { "value": "wsdl", "description": "The contents are inline and the document is a WSDL/Soap document." }, { "value": "wsdl-link", "description": "The WSDL document is hosted on a publicly accessible internet address." }, { "value": "openapi", "description": "The contents are inline and Content Type is a OpenAPI 3.0 YAML Document." }, { "value": "openapi+json", "description": "The contents are inline and Content Type is a OpenAPI 3.0 JSON Document." }, { "value": "openapi-link", "description": "The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address." }, { "value": "openapi+json-link", "description": "The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address." }, { "value": "graphql-link", "description": "The GraphQL API endpoint hosted on a publicly accessible internet address." }, { "value": "odata", "description": "The contents are inline and Content Type is a OData XML Document." }, { "value": "odata-link", "description": "The OData metadata document hosted on a publicly accessible internet address." }, { "value": "grpc", "description": "The contents are inline and Content Type is a gRPC protobuf file." }, { "value": "grpc-link", "description": "The gRPC protobuf file is hosted on a publicly accessible internet address." } ] } }, "wsdlSelector": { "type": "object", "description": "Criteria to limit import of WSDL to a subset of the document.", "properties": { "wsdlServiceName": { "type": "string", "description": "Name of service to import from WSDL" }, "wsdlEndpointName": { "type": "string", "description": "Name of endpoint(port) to import from WSDL" } } }, "apiType": { "type": "string", "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. \n New types can be added in the future.", "enum": [ "http", "soap", "websocket", "graphql", "odata", "grpc" ], "x-ms-client-name": "SoapApiType", "x-ms-enum": { "name": "SoapApiType", "modelAsString": true, "values": [ { "value": "http", "description": "Imports a SOAP API having a RESTful front end.", "name": "SoapToRest" }, { "value": "soap", "description": "Imports the SOAP API having a SOAP front end.", "name": "SoapPassThrough" }, { "value": "websocket", "description": "Imports the API having a Websocket front end.", "name": "WebSocket" }, { "value": "graphql", "description": "Imports the API having a GraphQL front end.", "name": "GraphQL" }, { "value": "odata", "description": "Imports the API having a OData front end.", "name": "OData" }, { "value": "grpc", "description": "Imports the API having a gRPC front end.", "name": "gRPC" } ] } }, "translateRequiredQueryParameters": { "type": "string", "description": "Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'", "enum": [ "template", "query" ], "x-ms-client-name": "TranslateRequiredQueryParametersConduct", "x-ms-enum": { "name": "TranslateRequiredQueryParametersConduct", "modelAsString": true, "values": [ { "value": "template", "description": "Translates required query parameters to template ones. Is a default value", "name": "Template" }, { "value": "query", "description": "Leaves required query parameters as they are (no translation done).", "name": "Query" } ] } } }, "allOf": [ { "$ref": "#/definitions/ApiContractProperties" } ], "description": "API Create or Update Properties." }, "ApiEntityBaseContract": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the API. May include HTML formatting tags." }, "authenticationSettings": { "$ref": "#/definitions/AuthenticationSettingsContract", "description": "Collection of authentication settings included into this API." }, "subscriptionKeyParameterNames": { "$ref": "#/definitions/SubscriptionKeyParameterNamesContract", "description": "Protocols over which API is made available." }, "type": { "type": "string", "description": "Type of API.", "enum": [ "http", "soap", "websocket", "graphql", "odata", "grpc" ], "x-ms-client-name": "ApiType", "x-ms-enum": { "name": "ApiType", "modelAsString": true } }, "apiRevision": { "type": "string", "description": "Describes the revision of the API. If no value is provided, default revision 1 is created", "minLength": 1, "maxLength": 100 }, "apiVersion": { "type": "string", "description": "Indicates the version identifier of the API if the API is versioned", "maxLength": 100 }, "isCurrent": { "type": "boolean", "description": "Indicates if API revision is current api revision." }, "isOnline": { "type": "boolean", "description": "Indicates if API revision is accessible via the gateway.", "readOnly": true }, "apiRevisionDescription": { "type": "string", "description": "Description of the API Revision.", "maxLength": 256 }, "apiVersionDescription": { "type": "string", "description": "Description of the API Version.", "maxLength": 256 }, "apiVersionSetId": { "type": "string", "description": "A resource identifier for the related ApiVersionSet." }, "subscriptionRequired": { "type": "boolean", "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." }, "contact": { "$ref": "#/definitions/ApiContactInformation", "description": "Contact information for the API." }, "license": { "$ref": "#/definitions/ApiLicenseInformation", "description": "License information for the API." } }, "description": "API base contract details." }, "ApiContactInformation": { "type": "object", "properties": { "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" }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address" } }, "description": "API contact information" }, "ApiLicenseInformation": { "type": "object", "description": "API license information", "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" } } }, "ApiExportResult": { "type": "object", "properties": { "id": { "type": "string", "description": "ResourceId of the API which was exported." }, "format": { "type": "string", "enum": [ "swagger-link-json", "wadl-link-json", "wsdl-link+xml", "openapi-link" ], "x-ms-client-name": "ExportResultFormat", "x-ms-enum": { "name": "ExportResultFormat", "modelAsString": true, "values": [ { "value": "swagger-link-json", "description": "The API Definition is exported in OpenAPI Specification 2.0 format to the Storage Blob.", "name": "Swagger" }, { "value": "wsdl-link+xml", "description": "The API Definition is exported in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`", "name": "Wsdl" }, { "value": "wadl-link-json", "description": "Export the API Definition in WADL Schema to Storage Blob.", "name": "Wadl" }, { "value": "openapi-link", "description": "Export the API Definition in OpenAPI Specification 3.0 to Storage Blob.", "name": "OpenApi" } ] }, "description": "Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes." }, "value": { "type": "object", "description": "The object defining the schema of the exported API Detail", "properties": { "link": { "type": "string", "description": "Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes." } } } }, "description": "API Export result." }, "ApiReleaseCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApiReleaseContract" }, "description": "Page values.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged ApiRelease list representation." }, "ApiReleaseContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApiReleaseContractProperties", "description": "ApiRelease entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "ApiRelease details." }, "ApiReleaseContractProperties": { "type": "object", "properties": { "apiId": { "type": "string", "description": "Identifier of the API the release belongs to." }, "createdDateTime": { "type": "string", "readOnly": true, "format": "date-time", "description": "The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." }, "updatedDateTime": { "type": "string", "readOnly": true, "format": "date-time", "description": "The time the API release was updated." }, "notes": { "type": "string", "description": "Release Notes" } }, "description": "API Release details" }, "ApiRevisionCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApiRevisionContract" }, "x-ms-identifiers": [ "apiId" ], "description": "Page values.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged API Revision list representation." }, "ApiRevisionContract": { "type": "object", "properties": { "apiId": { "type": "string", "readOnly": true, "description": "Identifier of the API Revision." }, "apiRevision": { "type": "string", "minLength": 1, "maxLength": 100, "readOnly": true, "description": "Revision number of API." }, "createdDateTime": { "type": "string", "readOnly": true, "format": "date-time", "description": "The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." }, "updatedDateTime": { "type": "string", "readOnly": true, "format": "date-time", "description": "The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." }, "description": { "type": "string", "readOnly": true, "maxLength": 256, "description": "Description of the API Revision." }, "privateUrl": { "type": "string", "readOnly": true, "description": "Gateway URL for accessing the non-current API Revision." }, "isOnline": { "type": "boolean", "readOnly": true, "description": "Indicates if API revision is the current api revision." }, "isCurrent": { "type": "boolean", "readOnly": true, "description": "Indicates if API revision is accessible via the gateway." } }, "description": "Summary of revision metadata." }, "ApiRevisionInfoContract": { "type": "object", "description": "Object used to create an API Revision or Version based on an existing API Revision", "properties": { "sourceApiId": { "type": "string", "description": "Resource identifier of API to be used to create the revision from." }, "apiVersionName": { "type": "string", "maxLength": 100, "description": "Version identifier for the new API Version." }, "apiRevisionDescription": { "type": "string", "maxLength": 256, "description": "Description of new API Revision." }, "apiVersionSet": { "description": "Version set details", "$ref": "#/definitions/ApiVersionSetContractDetails" } } }, "ApiTagResourceContractProperties": { "type": "object", "properties": { "id": { "type": "string", "description": "API identifier in the form /apis/{apiId}." }, "name": { "type": "string", "description": "API name.", "minLength": 1, "maxLength": 300 }, "serviceUrl": { "type": "string", "description": "Absolute URL of the backend service implementing this API.", "minLength": 1, "maxLength": 2000 }, "path": { "type": "string", "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.", "minLength": 0, "maxLength": 400 }, "protocols": { "type": "array", "items": { "type": "string", "enum": [ "http", "https", "ws", "wss" ], "x-ms-enum": { "name": "Protocol", "modelAsString": true } }, "description": "Describes on which protocols the operations in this API can be invoked." } }, "allOf": [ { "$ref": "./definitions.json#/definitions/ApiEntityBaseContract" } ], "description": "API contract properties for the Tag Resources." }, "ApiUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApiContractUpdateProperties", "description": "Properties of the API entity that can be updated." } }, "description": "API update contract details." }, "ApiContractUpdateProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "API name.", "minLength": 1, "maxLength": 300 }, "serviceUrl": { "type": "string", "description": "Absolute URL of the backend service implementing this API.", "minLength": 1, "maxLength": 2000 }, "path": { "type": "string", "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.", "minLength": 0, "maxLength": 400 }, "protocols": { "type": "array", "items": { "type": "string", "enum": [ "http", "https", "ws", "wss" ], "x-ms-enum": { "name": "Protocol", "modelAsString": true } }, "description": "Describes on which protocols the operations in this API can be invoked." } }, "allOf": [ { "$ref": "#/definitions/ApiEntityBaseContract" } ], "description": "API update contract properties." }, "ApiVersionSetCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApiVersionSetContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged API Version Set list representation." }, "ApiVersionSetContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApiVersionSetContractProperties", "description": "API VersionSet contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "API Version Set Contract details." }, "ApiVersionSetContractDetails": { "type": "object", "description": "An API Version Set contains the common configuration for a set of API Versions relating ", "properties": { "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." }, "description": { "type": "string", "description": "Description of API Version Set." }, "versioningScheme": { "type": "string", "description": "An value that determines where the API Version identifier will be located in a HTTP request.", "enum": [ "Segment", "Query", "Header" ], "x-ms-enum": { "name": "versioningScheme", "modelAsString": true, "values": [ { "value": "Segment", "description": "The API Version is passed in a path segment." }, { "value": "Query", "description": "The API Version is passed in a query parameter." }, { "value": "Header", "description": "The API Version is passed in a HTTP header." } ] } }, "versionQueryName": { "type": "string", "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`." }, "versionHeaderName": { "type": "string", "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`." } } }, "ApiVersionSetContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of API Version Set", "minLength": 1, "maxLength": 100 }, "versioningScheme": { "type": "string", "description": "An value that determines where the API Version identifier will be located in a HTTP request.", "enum": [ "Segment", "Query", "Header" ], "x-ms-enum": { "name": "versioningScheme", "modelAsString": true, "values": [ { "value": "Segment", "description": "The API Version is passed in a path segment." }, { "value": "Query", "description": "The API Version is passed in a query parameter." }, { "value": "Header", "description": "The API Version is passed in a HTTP header." } ] } } }, "allOf": [ { "$ref": "#/definitions/ApiVersionSetEntityBase" } ], "required": [ "displayName", "versioningScheme" ], "description": "Properties of an API Version Set." }, "ApiVersionSetEntityBase": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of API Version Set." }, "versionQueryName": { "type": "string", "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`.", "minLength": 1, "maxLength": 100 }, "versionHeaderName": { "type": "string", "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.", "minLength": 1, "maxLength": 100 } }, "description": "API Version set base parameters" }, "ApiVersionSetUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApiVersionSetUpdateParametersProperties", "description": "Parameters to update or create an API Version Set Contract." } }, "description": "Parameters to update or create an API Version Set Contract." }, "ApiVersionSetUpdateParametersProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of API Version Set", "minLength": 1, "maxLength": 100 }, "versioningScheme": { "type": "string", "description": "An value that determines where the API Version identifier will be located in a HTTP request.", "enum": [ "Segment", "Query", "Header" ], "x-ms-enum": { "name": "versioningScheme", "modelAsString": true, "values": [ { "value": "Segment", "description": "The API Version is passed in a path segment." }, { "value": "Query", "description": "The API Version is passed in a query parameter." }, { "value": "Header", "description": "The API Version is passed in a HTTP header." } ] } } }, "allOf": [ { "$ref": "#/definitions/ApiVersionSetEntityBase" } ], "description": "Properties used to create or update an API Version Set." }, "AuthenticationSettingsContract": { "type": "object", "properties": { "oAuth2": { "$ref": "#/definitions/OAuth2AuthenticationSettingsContract", "description": "OAuth2 Authentication settings" }, "openid": { "$ref": "#/definitions/OpenIdAuthenticationSettingsContract", "description": "OpenID Connect Authentication Settings" }, "oAuth2AuthenticationSettings": { "type": "array", "items": { "$ref": "#/definitions/OAuth2AuthenticationSettingsContract" }, "x-ms-identifiers": [ "authorizationServerId" ], "description": "Collection of OAuth2 authentication settings included into this API." }, "openidAuthenticationSettings": { "type": "array", "items": { "$ref": "#/definitions/OpenIdAuthenticationSettingsContract" }, "x-ms-identifiers": [ "openidProviderId" ], "description": "Collection of Open ID Connect authentication settings included into this API." } }, "description": "API Authentication Settings." }, "AuthorizationCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/AuthorizationContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Authorization list representation." }, "AuthorizationContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AuthorizationContractProperties", "description": "Properties of the Authorization Contract." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Authorization contract." }, "AuthorizationContractProperties": { "type": "object", "properties": { "authorizationType": { "type": "string", "description": "Authorization type options", "enum": [ "OAuth2" ], "x-ms-client-name": "AuthorizationType", "x-ms-enum": { "name": "AuthorizationType", "modelAsString": true, "values": [ { "value": "OAuth2", "description": "OAuth2 authorization type", "name": "OAuth2" } ] } }, "oauth2grantType": { "type": "string", "description": "OAuth2 grant type options", "enum": [ "AuthorizationCode", "ClientCredentials" ], "x-ms-client-name": "OAuth2GrantType", "x-ms-enum": { "name": "OAuth2GrantType", "modelAsString": true, "values": [ { "value": "AuthorizationCode", "description": "Authorization Code grant", "name": "AuthorizationCode" }, { "value": "ClientCredentials", "description": "Client Credential grant", "name": "ClientCredentials" } ] } }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Authorization parameters" }, "error": { "description": "", "$ref": "#/definitions/AuthorizationError" }, "status": { "type": "string", "description": "Status of the Authorization" } }, "description": "Authorization details." }, "AuthorizationError": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message" } }, "description": "Authorization error details." }, "AuthorizationAccessPolicyCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/AuthorizationAccessPolicyContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Authorization Access Policy list representation." }, "AuthorizationAccessPolicyContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AuthorizationAccessPolicyContractProperties", "description": "Properties of the Authorization Contract." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Authorization access policy contract." }, "AuthorizationAccessPolicyContractProperties": { "type": "object", "properties": { "appIds": { "type": "array", "items": { "type": "string" }, "description": "The allowed Azure Active Directory Application IDs" }, "tenantId": { "type": "string", "description": "The Tenant Id" }, "objectId": { "type": "string", "description": "The Object Id" } }, "description": "Authorization Access Policy details." }, "AuthorizationLoginRequestContract": { "type": "object", "properties": { "postLoginRedirectUrl": { "type": "string", "description": "The redirect URL after login has completed." } }, "description": "Authorization login request contract." }, "AuthorizationLoginResponseContract": { "type": "object", "properties": { "loginLink": { "type": "string", "description": "The login link" } }, "description": "Authorization login response contract." }, "AuthorizationConfirmConsentCodeRequestContract": { "type": "object", "properties": { "consentCode": { "type": "string", "description": "The consent code from the authorization server after authorizing and consenting." } }, "description": "Authorization confirm consent code request contract." }, "AuthorizationProviderCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/AuthorizationProviderContract" }, "description": "Page values." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Authorization Provider list representation." }, "AuthorizationProviderContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AuthorizationProviderContractProperties", "description": "Properties of the Authorization Provider Contract." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Authorization Provider contract." }, "AuthorizationProviderContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Authorization Provider name. Must be 1 to 300 characters long.", "minLength": 1, "maxLength": 300 }, "identityProvider": { "type": "string", "description": "Identity provider name. Must be 1 to 300 characters long." }, "oauth2": { "description": "OAuth2 settings", "$ref": "#/definitions/AuthorizationProviderOAuth2Settings" } }, "description": "Authorization Provider details." }, "AuthorizationProviderOAuth2Settings": { "type": "object", "properties": { "redirectUrl": { "type": "string", "description": "Redirect URL to be set in the OAuth application." }, "grantTypes": { "description": "OAuth2 settings", "$ref": "#/definitions/AuthorizationProviderOAuth2GrantTypes" } }, "description": "OAuth2 settings details" }, "AuthorizationProviderOAuth2GrantTypes": { "type": "object", "properties": { "authorizationCode": { "type": "object", "additionalProperties": { "type": "string" }, "description": "OAuth2 authorization code grant parameters" }, "clientCredentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "OAuth2 client credential grant parameters" } }, "description": "Authorization Provider oauth2 grant types settings" }, "AuthorizationServerCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/AuthorizationServerContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged OAuth2 Authorization Servers list representation." }, "AuthorizationServerContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AuthorizationServerContractProperties", "description": "Properties of the External OAuth authorization server Contract." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "External OAuth authorization server settings." }, "AuthorizationServerContractBaseProperties": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the authorization server. Can contain HTML formatting tags." }, "authorizationMethods": { "type": "array", "items": { "type": "string", "enum": [ "HEAD", "OPTIONS", "TRACE", "GET", "POST", "PUT", "PATCH", "DELETE" ], "x-ms-enum": { "name": "AuthorizationMethod", "modelAsString": false } }, "description": "HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional." }, "clientAuthenticationMethod": { "type": "array", "items": { "type": "string", "enum": [ "Basic", "Body" ], "x-ms-enum": { "name": "ClientAuthenticationMethod", "modelAsString": true, "values": [ { "value": "Basic", "description": "Basic Client Authentication method." }, { "value": "Body", "description": "Body based Authentication method." } ] } }, "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." }, "tokenBodyParameters": { "type": "array", "items": { "$ref": "#/definitions/TokenBodyParameterContract" }, "x-ms-identifiers": [ "name" ], "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.", "externalDocs": { "url": "http://tools.ietf.org/html/rfc6749#section-3.1" } }, "supportState": { "type": "boolean", "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.", "externalDocs": { "url": "http://tools.ietf.org/html/rfc6749#section-3.1" } }, "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.", "externalDocs": { "url": "http://tools.ietf.org/html/rfc6749#section-3.3" } }, "bearerTokenSendingMethods": { "type": "array", "items": { "type": "string", "enum": [ "authorizationHeader", "query" ], "x-ms-enum": { "name": "BearerTokenSendingMethod", "modelAsString": true } }, "description": "Specifies the mechanism by which access token is passed to the API. ", "externalDocs": { "url": "http://tools.ietf.org/html/rfc6749#section-4" } }, "resourceOwnerUsername": { "type": "string", "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." }, "resourceOwnerPassword": { "type": "string", "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." } }, "description": "External OAuth authorization server Update settings contract." }, "AuthorizationServerContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "User-friendly authorization server name.", "minLength": 1, "maxLength": 50 }, "useInTestConsole": { "type": "boolean", "description": "If true, the authorization server may be used in the developer portal test console. True by default if no value is provided." }, "useInApiDocumentation": { "type": "boolean", "description": "If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided." }, "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." }, "authorizationEndpoint": { "type": "string", "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." }, "grantTypes": { "type": "array", "items": { "type": "string", "enum": [ "authorizationCode", "implicit", "resourceOwnerPassword", "clientCredentials" ], "x-ms-enum": { "name": "GrantType", "modelAsString": true, "values": [ { "value": "authorizationCode", "description": "Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1." }, { "value": "implicit", "description": "Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2." }, { "value": "resourceOwnerPassword", "description": "Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3." }, { "value": "clientCredentials", "description": "Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4." } ] } }, "description": "Form of an authorization grant, which the client uses to request the access token.", "externalDocs": { "url": "http://tools.ietf.org/html/rfc6749#section-4" } }, "clientId": { "type": "string", "description": "Client or app id registered with this authorization server." }, "clientSecret": { "x-ms-secret": true, "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." } }, "allOf": [ { "$ref": "#/definitions/AuthorizationServerContractBaseProperties" } ], "required": [ "displayName", "clientRegistrationEndpoint", "authorizationEndpoint", "clientId", "grantTypes" ], "description": "External OAuth authorization server settings Properties." }, "AuthorizationServerUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AuthorizationServerUpdateContractProperties", "description": "Properties of the External OAuth authorization server update Contract." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "External OAuth authorization server settings." }, "AuthorizationServerUpdateContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "User-friendly authorization server name.", "minLength": 1, "maxLength": 50 }, "useInTestConsole": { "type": "boolean", "description": "If true, the authorization server may be used in the developer portal test console. True by default if no value is provided." }, "useInApiDocumentation": { "type": "boolean", "description": "If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided." }, "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." }, "authorizationEndpoint": { "type": "string", "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." }, "grantTypes": { "type": "array", "items": { "type": "string", "enum": [ "authorizationCode", "implicit", "resourceOwnerPassword", "clientCredentials" ], "x-ms-enum": { "name": "GrantType", "modelAsString": true, "values": [ { "value": "authorizationCode", "description": "Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1." }, { "value": "implicit", "description": "Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2." }, { "value": "resourceOwnerPassword", "description": "Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3." }, { "value": "clientCredentials", "description": "Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4." } ] } }, "description": "Form of an authorization grant, which the client uses to request the access token.", "externalDocs": { "url": "http://tools.ietf.org/html/rfc6749#section-4" } }, "clientId": { "type": "string", "description": "Client or app id registered with this authorization server." }, "clientSecret": { "x-ms-secret": true, "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." } }, "allOf": [ { "$ref": "#/definitions/AuthorizationServerContractBaseProperties" } ], "description": "External OAuth authorization server Update settings contract." }, "AuthorizationServerSecretsContract": { "type": "object", "properties": { "clientSecret": { "type": "string", "x-ms-secret": true, "description": "oAuth Authorization Server Secrets." }, "resourceOwnerUsername": { "type": "string", "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." }, "resourceOwnerPassword": { "type": "string", "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." } }, "description": "OAuth Server Secrets Contract." }, "BackendAuthorizationHeaderCredentials": { "type": "object", "properties": { "scheme": { "type": "string", "description": "Authentication Scheme name.", "minLength": 1, "maxLength": 100 }, "parameter": { "type": "string", "description": "Authentication Parameter value.", "minLength": 1, "maxLength": 300 } }, "required": [ "scheme", "parameter" ], "description": "Authorization header information." }, "BackendBaseParameters": { "type": "object", "properties": { "title": { "type": "string", "description": "Backend Title.", "minLength": 1, "maxLength": 300 }, "description": { "type": "string", "description": "Backend Description.", "minLength": 1, "maxLength": 2000 }, "resourceId": { "type": "string", "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.", "minLength": 1, "maxLength": 2000 }, "properties": { "$ref": "#/definitions/BackendProperties", "description": "Backend Properties contract" }, "credentials": { "$ref": "#/definitions/BackendCredentialsContract", "description": "Backend Credentials Contract Properties" }, "proxy": { "$ref": "#/definitions/BackendProxyContract", "description": "Backend gateway Contract Properties" }, "tls": { "$ref": "#/definitions/BackendTlsProperties", "description": "Backend TLS Properties" }, "circuitBreaker": { "$ref": "#/definitions/BackendCircuitBreaker", "description": "Backend Circuit Breaker Configuration" }, "pool": { "allOf": [ { "$ref": "#/definitions/BackendPool" }, { "description": "Backend Pool Properties" } ] }, "type": { "type": "string", "enum": [ "Single", "Pool" ], "x-ms-enum": { "name": "BackendType", "modelAsString": true, "values": [ { "value": "Single", "description": "supports single backend" }, { "value": "Pool", "description": "supports pool backend" } ] }, "description": "Type of the backend. A backend can be either Single or Pool." } }, "description": "Backend entity base Parameter set." }, "BackendCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/BackendContract" }, "description": "Backend values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Backend list representation." }, "BackendContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/BackendContractProperties", "description": "Backend entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Backend details." }, "BackendContractProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "Runtime Url of the Backend. Required when backend type is 'Single'.", "minLength": 1, "maxLength": 2000 }, "protocol": { "type": "string", "enum": [ "http", "soap" ], "x-ms-enum": { "name": "BackendProtocol", "modelAsString": true, "values": [ { "value": "http", "description": "The Backend is a RESTful service." }, { "value": "soap", "description": "The Backend is a SOAP service." } ] }, "description": "Backend communication protocol. Required when backend type is 'Single'." } }, "allOf": [ { "$ref": "#/definitions/BackendBaseParameters" } ], "description": "Parameters supplied to the Create Backend operation." }, "BackendCredentialsContract": { "type": "object", "properties": { "certificateIds": { "type": "array", "items": { "type": "string" }, "maxItems": 32, "description": "List of Client Certificate Ids." }, "certificate": { "type": "array", "items": { "type": "string" }, "maxItems": 32, "description": "List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided." }, "query": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Query Parameter description." }, "header": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Header Parameter description." }, "authorization": { "description": "Authorization header authentication", "$ref": "#/definitions/BackendAuthorizationHeaderCredentials" } }, "description": "Details of the Credentials used to connect to Backend." }, "BackendProperties": { "type": "object", "properties": { "serviceFabricCluster": { "$ref": "#/definitions/BackendServiceFabricClusterProperties", "description": "Backend Service Fabric Cluster Properties" } }, "description": "Properties specific to the Backend Type." }, "BackendProxyContract": { "type": "object", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/system.net.webproxy(v=vs.110).aspx", "description": "Backend entity uses these details to connect to a WebProxy." }, "properties": { "url": { "type": "string", "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.", "minLength": 1, "maxLength": 2000 }, "username": { "type": "string", "description": "Username to connect to the WebProxy server" }, "password": { "type": "string", "description": "Password to connect to the WebProxy Server" } }, "required": [ "url" ], "description": "Details of the Backend WebProxy Server to use in the Request to Backend." }, "BackendReconnectContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/BackendReconnectProperties", "description": "Reconnect request properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Reconnect request parameters." }, "BackendReconnectProperties": { "type": "object", "properties": { "after": { "type": "string", "format": "duration", "description": "Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M." } }, "description": "Properties to control reconnect requests." }, "BackendServiceFabricClusterProperties": { "type": "object", "properties": { "clientCertificateId": { "description": "The client certificate id for the management endpoint.", "type": "string" }, "clientCertificatethumbprint": { "description": "The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided", "type": "string" }, "maxPartitionResolutionRetries": { "description": "Maximum number of retries while attempting resolve the partition.", "format": "int32", "type": "integer" }, "managementEndpoints": { "type": "array", "items": { "type": "string" }, "description": "The cluster management endpoint." }, "serverCertificateThumbprints": { "type": "array", "items": { "type": "string" }, "description": "Thumbprints of certificates cluster management service uses for tls communication" }, "serverX509Names": { "type": "array", "items": { "$ref": "#/definitions/X509CertificateName" }, "x-ms-identifiers": [ "name" ], "description": "Server X509 Certificate Names Collection" } }, "required": [ "managementEndpoints" ], "description": "Properties of the Service Fabric Type Backend." }, "BackendTlsProperties": { "type": "object", "properties": { "validateCertificateChain": { "description": "Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.", "type": "boolean", "default": true }, "validateCertificateName": { "description": "Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.", "type": "boolean", "default": true } }, "description": "Properties controlling TLS Certificate Validation." }, "BackendUpdateParameterProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "Runtime Url of the Backend. Required when backend type is 'Single'.", "minLength": 1, "maxLength": 2000 }, "protocol": { "type": "string", "enum": [ "http", "soap" ], "x-ms-enum": { "name": "BackendProtocol", "modelAsString": true, "values": [ { "value": "http", "description": "The Backend is a RESTful service." }, { "value": "soap", "description": "The Backend is a SOAP service." } ] }, "description": "Backend communication protocol. Required when backend type is 'Single'." } }, "allOf": [ { "$ref": "#/definitions/BackendBaseParameters" } ], "description": "Parameters supplied to the Update Backend operation." }, "BackendUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/BackendUpdateParameterProperties", "description": "Backend entity update contract properties." } }, "description": "Backend update parameters." }, "BackendCircuitBreaker": { "type": "object", "description": "The configuration of the backend circuit breaker", "properties": { "rules": { "type": "array", "items": { "$ref": "#/definitions/CircuitBreakerRule" }, "maxItems": 15, "description": "The rules for tripping the backend.", "x-ms-identifiers": [] } } }, "CircuitBreakerRule": { "type": "object", "description": "Rule configuration to trip the backend.", "properties": { "name": { "type": "string", "description": "The rule name." }, "failureCondition": { "$ref": "#/definitions/CircuitBreakerFailureCondition", "description": "The conditions for tripping the circuit breaker." }, "tripDuration": { "type": "string", "format": "duration", "description": "The duration for which the circuit will be tripped." }, "acceptRetryAfter": { "type": "boolean", "description": "flag to accept Retry-After header from the backend." } } }, "CircuitBreakerFailureCondition": { "type": "object", "description": "The trip conditions of the circuit breaker", "properties": { "count": { "type": "integer", "format": "int64", "description": "The threshold for opening the circuit." }, "percentage": { "type": "integer", "format": "int64", "description": "The threshold for opening the circuit." }, "interval": { "type": "string", "format": "duration", "description": "The interval during which the failures are counted." }, "statusCodeRanges": { "type": "array", "items": { "$ref": "#/definitions/FailureStatusCodeRange" }, "maxItems": 10, "description": "The status code ranges which are considered as failure.", "x-ms-identifiers": [] }, "errorReasons": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 10, "description": "The error reasons which are considered as failure.", "x-ms-identifiers": [] } } }, "FailureStatusCodeRange": { "type": "object", "description": "The failure http status code range", "properties": { "min": { "type": "integer", "format": "int32", "description": "The minimum http status code.", "minimum": 200, "maximum": 599 }, "max": { "type": "integer", "format": "int32", "description": "The maximum http status code.", "minimum": 200, "maximum": 599 } } }, "BackendPool": { "type": "object", "description": "Backend pool information", "properties": { "services": { "type": "array", "description": "The list of backend entities belonging to a pool.", "items": { "$ref": "#/definitions/BackendPoolItem" }, "minItems": 1, "x-ms-identifiers": [], "example": { "services": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends" } } } }, "BackendPoolItem": { "type": "object", "description": "Backend pool service information", "properties": { "id": { "type": "string", "format": "arm-id", "description": "The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.", "example": { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend" } }, "weight": { "type": "integer", "format": "int32", "description": "The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.", "minimum": 0, "maximum": 100, "example": { "weight": 1 } }, "priority": { "type": "integer", "format": "int32", "description": "The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.", "minimum": 0, "maximum": 100, "example": { "priority": 1 } } }, "required": [ "id" ] }, "BearerTokenSendingMethodsContract": { "type": "string", "description": "Form of an authorization grant, which the client uses to request the access token.", "enum": [ "authorizationHeader", "query" ], "x-ms-enum": { "modelAsString": true, "name": "bearerTokenSendingMethods", "values": [ { "value": "authorizationHeader", "description": "Access token will be transmitted in the Authorization header using Bearer schema" }, { "value": "query", "description": "Access token will be transmitted as query parameters." } ] } }, "BodyDiagnosticSettings": { "type": "object", "properties": { "bytes": { "type": "integer", "format": "int32", "maximum": 8192, "description": "Number of request body bytes to log." } }, "description": "Body logging settings." }, "CacheCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/CacheContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Caches list representation." }, "CacheContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/CacheContractProperties", "description": "Cache properties details." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Cache details." }, "CacheContractProperties": { "type": "object", "properties": { "description": { "type": "string", "description": "Cache description", "maxLength": 2000 }, "connectionString": { "type": "string", "description": "Runtime connection string to cache", "maxLength": 300 }, "useFromLocation": { "type": "string", "description": "Location identifier to use cache from (should be either 'default' or valid Azure region identifier)", "maxLength": 256 }, "resourceId": { "type": "string", "description": "Original uri of entity in external system cache points to", "maxLength": 2000 } }, "required": [ "connectionString", "useFromLocation" ], "description": "Properties of the Cache contract." }, "CacheUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/CacheUpdateProperties", "description": "Cache update properties details." } }, "description": "Cache update details." }, "CacheUpdateProperties": { "type": "object", "properties": { "description": { "type": "string", "description": "Cache description", "maxLength": 2000 }, "connectionString": { "type": "string", "description": "Runtime connection string to cache", "maxLength": 300 }, "useFromLocation": { "type": "string", "description": "Location identifier to use cache from (should be either 'default' or valid Azure region identifier)", "maxLength": 256 }, "resourceId": { "type": "string", "description": "Original uri of entity in external system cache points to", "maxLength": 2000 } }, "description": "Parameters supplied to the Update Cache operation." }, "CertificateCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/CertificateContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Certificates list representation." }, "CertificateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/CertificateContractProperties", "description": "Certificate properties details." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Certificate details." }, "CertificateContractProperties": { "type": "object", "properties": { "subject": { "type": "string", "description": "Subject attribute of the certificate." }, "thumbprint": { "type": "string", "description": "Thumbprint of the certificate." }, "expirationDate": { "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.\n" }, "keyVault": { "$ref": "#/definitions/KeyVaultContractProperties", "description": "KeyVault location details of the certificate." } }, "required": [ "subject", "thumbprint", "expirationDate" ], "description": "Properties of the Certificate contract." }, "CertificateCreateOrUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/CertificateCreateOrUpdateProperties", "description": "Certificate create or update properties details." } }, "description": "Certificate create or update details." }, "CertificateCreateOrUpdateProperties": { "type": "object", "properties": { "data": { "type": "string", "description": "Base 64 encoded certificate using the application/x-pkcs12 representation." }, "password": { "type": "string", "description": "Password for the Certificate" }, "keyVault": { "$ref": "#/definitions/KeyVaultContractCreateProperties", "description": "KeyVault location details of the certificate." } }, "description": "Parameters supplied to the CreateOrUpdate certificate operation." }, "DataMasking": { "type": "object", "properties": { "queryParams": { "type": "array", "items": { "$ref": "#/definitions/DataMaskingEntity" }, "x-ms-identifiers": [], "description": "Masking settings for Url query parameters" }, "headers": { "type": "array", "items": { "$ref": "#/definitions/DataMaskingEntity" }, "x-ms-identifiers": [], "description": "Masking settings for headers" } } }, "DataMaskingEntity": { "type": "object", "properties": { "value": { "type": "string", "description": "The name of an entity to mask (e.g. a name of a header or a query parameter)." }, "mode": { "type": "string", "enum": [ "Mask", "Hide" ], "x-ms-enum": { "name": "DataMaskingMode", "modelAsString": true, "values": [ { "value": "Mask", "description": "Mask the value of an entity." }, { "value": "Hide", "description": "Hide the presence of an entity." } ] }, "description": "Data masking mode." } } }, "DeployConfigurationParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DeployConfigurationParameterProperties", "description": "Deploy Configuration Parameter contract properties." } }, "description": "Deploy Tenant Configuration Contract." }, "DeployConfigurationParameterProperties": { "type": "object", "properties": { "branch": { "type": "string", "description": "The name of the Git branch from which the configuration is to be deployed to the configuration database." }, "force": { "type": "boolean", "description": "The value enforcing deleting subscriptions to products that are deleted in this update." } }, "required": [ "branch" ], "description": "Parameters supplied to the Deploy Configuration operation." }, "DiagnosticCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/DiagnosticContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Diagnostic list representation." }, "DiagnosticContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DiagnosticContractProperties", "description": "Diagnostic entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Diagnostic details." }, "DiagnosticContractProperties": { "type": "object", "properties": { "alwaysLog": { "type": "string", "enum": [ "allErrors" ], "x-ms-enum": { "name": "AlwaysLog", "modelAsString": true, "values": [ { "value": "allErrors", "description": "Always log all erroneous request regardless of sampling settings." } ] }, "description": "Specifies for what type of messages sampling settings should not apply." }, "loggerId": { "type": "string", "description": "Resource Id of a target logger." }, "sampling": { "$ref": "#/definitions/SamplingSettings", "description": "Sampling settings for Diagnostic." }, "frontend": { "$ref": "#/definitions/PipelineDiagnosticSettings", "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." }, "backend": { "$ref": "#/definitions/PipelineDiagnosticSettings", "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Backend" }, "logClientIp": { "type": "boolean", "description": "Log the ClientIP. Default is false." }, "httpCorrelationProtocol": { "type": "string", "enum": [ "None", "Legacy", "W3C" ], "x-ms-enum": { "name": "HttpCorrelationProtocol", "modelAsString": true, "values": [ { "value": "None", "description": "Do not read and inject correlation headers." }, { "value": "Legacy", "description": "Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md." }, { "value": "W3C", "description": "Inject Trace Context headers. See https://w3c.github.io/trace-context." } ] }, "description": "Sets correlation protocol to use for Application Insights diagnostics." }, "verbosity": { "type": "string", "enum": [ "verbose", "information", "error" ], "x-ms-enum": { "name": "Verbosity", "modelAsString": true, "values": [ { "value": "verbose", "description": "All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance." }, { "value": "information", "description": "Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance." }, { "value": "error", "description": "Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance." } ] }, "description": "The verbosity level applied to traces emitted by trace policies." }, "operationNameFormat": { "type": "string", "enum": [ "Name", "Url" ], "x-ms-enum": { "name": "OperationNameFormat", "modelAsString": true, "values": [ { "value": "Name", "description": "API_NAME;rev=API_REVISION - OPERATION_NAME" }, { "value": "Url", "description": "HTTP_VERB URL" } ] }, "description": "The format of the Operation Name for Application Insights telemetries. Default is Name." }, "metrics": { "type": "boolean", "description": "Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings." } }, "required": [ "loggerId" ], "description": "Diagnostic Entity Properties" }, "DiagnosticUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DiagnosticContractUpdateProperties", "description": "Diagnostic entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Diagnostic details." }, "DiagnosticContractUpdateProperties": { "type": "object", "properties": { "alwaysLog": { "type": "string", "enum": [ "allErrors" ], "x-ms-enum": { "name": "AlwaysLog", "modelAsString": true, "values": [ { "value": "allErrors", "description": "Always log all erroneous request regardless of sampling settings." } ] }, "description": "Specifies for what type of messages sampling settings should not apply." }, "loggerId": { "type": "string", "description": "Resource Id of a target logger." }, "sampling": { "$ref": "#/definitions/SamplingSettings", "description": "Sampling settings for Diagnostic." }, "frontend": { "$ref": "#/definitions/PipelineDiagnosticSettings", "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." }, "backend": { "$ref": "#/definitions/PipelineDiagnosticSettings", "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Backend" }, "logClientIp": { "type": "boolean", "description": "Log the ClientIP. Default is false." }, "httpCorrelationProtocol": { "type": "string", "enum": [ "None", "Legacy", "W3C" ], "x-ms-enum": { "name": "HttpCorrelationProtocol", "modelAsString": true, "values": [ { "value": "None", "description": "Do not read and inject correlation headers." }, { "value": "Legacy", "description": "Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md." }, { "value": "W3C", "description": "Inject Trace Context headers. See https://w3c.github.io/trace-context." } ] }, "description": "Sets correlation protocol to use for Application Insights diagnostics." }, "verbosity": { "type": "string", "enum": [ "verbose", "information", "error" ], "x-ms-enum": { "name": "Verbosity", "modelAsString": true, "values": [ { "value": "verbose", "description": "All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance." }, { "value": "information", "description": "Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance." }, { "value": "error", "description": "Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance." } ] }, "description": "The verbosity level applied to traces emitted by trace policies." }, "operationNameFormat": { "type": "string", "enum": [ "Name", "Url" ], "x-ms-enum": { "name": "OperationNameFormat", "modelAsString": true, "values": [ { "value": "Name", "description": "API_NAME;rev=API_REVISION - OPERATION_NAME" }, { "value": "Url", "description": "HTTP_VERB URL" } ] }, "description": "The format of the Operation Name for Application Insights telemetries. Default is Name." }, "metrics": { "type": "boolean", "description": "Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings." } }, "description": "Diagnostic Entity Properties" }, "EmailTemplateCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/EmailTemplateContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged email template list representation." }, "EmailTemplateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/EmailTemplateContractProperties", "description": "Email Template entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Email Template details." }, "EmailTemplateContractProperties": { "type": "object", "properties": { "subject": { "type": "string", "description": "Subject of the Template.", "minLength": 1, "maxLength": 1000 }, "body": { "type": "string", "description": "Email Template Body. This should be a valid XDocument", "minLength": 1 }, "title": { "type": "string", "description": "Title of the Template." }, "description": { "type": "string", "description": "Description of the Email Template." }, "isDefault": { "type": "boolean", "description": "Whether the template is the default template provided by API Management or has been edited.", "readOnly": true }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/EmailTemplateParametersContractProperties" }, "x-ms-identifiers": [ "title" ], "description": "Email Template Parameter values." } }, "required": [ "body", "subject" ], "description": "Email Template Contract properties." }, "EmailTemplateParametersContractProperties": { "type": "object", "properties": { "name": { "type": "string", "description": "Template parameter name.", "minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9-._]+$" }, "title": { "type": "string", "description": "Template parameter title.", "minLength": 1, "maxLength": 4096 }, "description": { "type": "string", "description": "Template parameter description.", "minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9-._]+$" } }, "description": "Email Template Parameter contract." }, "EmailTemplateUpdateParameterProperties": { "type": "object", "properties": { "subject": { "type": "string", "description": "Subject of the Template.", "minLength": 1, "maxLength": 1000 }, "title": { "type": "string", "description": "Title of the Template." }, "description": { "type": "string", "description": "Description of the Email Template." }, "body": { "type": "string", "description": "Email Template Body. This should be a valid XDocument", "minLength": 1 }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/EmailTemplateParametersContractProperties" }, "x-ms-identifiers": [ "title" ], "description": "Email Template Parameter values." } }, "description": "Email Template Update Contract properties." }, "EmailTemplateUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/EmailTemplateUpdateParameterProperties", "description": "Email Template Update contract properties." } }, "description": "Email Template update Parameters." }, "GenerateSsoUrlResult": { "type": "object", "properties": { "value": { "type": "string", "description": "Redirect Url containing the SSO URL value." } }, "description": "Generate SSO Url operations response details." }, "GroupCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/GroupContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Group list representation." }, "GroupContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/GroupContractProperties", "description": "Group entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Contract details." }, "GroupContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Group name.", "maxLength": 300, "minLength": 1 }, "description": { "type": "string", "description": "Group description. Can contain HTML formatting tags.", "maxLength": 1000 }, "builtIn": { "readOnly": true, "type": "boolean", "description": "true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false." }, "type": { "type": "string", "description": "Group type.", "enum": [ "custom", "system", "external" ], "x-ms-enum": { "name": "GroupType", "modelAsString": false } }, "externalId": { "type": "string", "description": "For 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." } }, "required": [ "displayName" ], "description": "Group contract Properties." }, "GroupCreateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/GroupCreateParametersProperties", "description": "Properties supplied to Create Group operation." } }, "description": "Parameters supplied to the Create Group operation." }, "GroupCreateParametersProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Group name.", "maxLength": 300, "minLength": 1 }, "description": { "type": "string", "description": "Group description." }, "type": { "type": "string", "description": "Group type.", "enum": [ "custom", "system", "external" ], "x-ms-enum": { "name": "GroupType", "modelAsString": false } }, "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." } }, "required": [ "displayName" ], "description": "Parameters supplied to the Create Group operation." }, "GroupUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/GroupUpdateParametersProperties", "description": "Group entity update contract properties." } }, "description": "Parameters supplied to the Update Group operation." }, "GroupUpdateParametersProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Group name.", "maxLength": 300, "minLength": 1 }, "description": { "type": "string", "description": "Group description." }, "type": { "type": "string", "description": "Group type.", "enum": [ "custom", "system", "external" ], "x-ms-enum": { "name": "GroupType", "modelAsString": false } }, "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." } }, "description": "Parameters supplied to the Update Group operation." }, "HttpMessageDiagnostic": { "type": "object", "properties": { "headers": { "type": "array", "items": { "type": "string" }, "description": "Array of HTTP Headers to log." }, "body": { "$ref": "#/definitions/BodyDiagnosticSettings", "description": "Body logging settings." }, "dataMasking": { "$ref": "#/definitions/DataMasking", "description": "Data masking settings." } }, "description": "Http message diagnostic settings." }, "IdentityProviderBaseParameters": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "facebook", "google", "microsoft", "twitter", "aad", "aadB2C" ], "x-ms-enum": { "name": "IdentityProviderType", "modelAsString": true, "values": [ { "value": "facebook", "description": "Facebook as Identity provider." }, { "value": "google", "description": "Google as Identity provider." }, { "value": "microsoft", "description": "Microsoft Live as Identity provider." }, { "value": "twitter", "description": "Twitter as Identity provider." }, { "value": "aad", "description": "Azure Active Directory as Identity provider." }, { "value": "aadB2C", "description": "Azure Active Directory B2C as Identity provider." } ] }, "description": "Identity Provider Type identifier." }, "signinTenant": { "type": "string", "description": "The TenantId to use instead of Common when logging into Active Directory" }, "allowedTenants": { "type": "array", "items": { "type": "string" }, "maxItems": 32, "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." }, "signupPolicyName": { "type": "string", "description": "Signup Policy Name. Only applies to AAD B2C Identity Provider.", "minLength": 1 }, "signinPolicyName": { "type": "string", "description": "Signin Policy Name. Only applies to AAD B2C Identity Provider.", "minLength": 1 }, "profileEditingPolicyName": { "type": "string", "description": "Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.", "minLength": 1 }, "passwordResetPolicyName": { "type": "string", "description": "Password Reset Policy Name. Only applies to AAD B2C Identity Provider.", "minLength": 1 }, "clientLibrary": { "type": "string", "description": "The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.", "minLength": 0, "maxLength": 16 } }, "description": "Identity Provider Base Parameter Properties." }, "IdentityProviderCreateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IdentityProviderCreateContractProperties", "description": "Identity Provider contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Identity Provider details." }, "IdentityProviderCreateContractProperties": { "type": "object", "properties": { "clientId": { "type": "string", "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.", "minLength": 1 }, "clientSecret": { "x-ms-secret": true, "type": "string", "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.", "minLength": 1 } }, "allOf": [ { "$ref": "#/definitions/IdentityProviderBaseParameters" } ], "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." }, "IdentityProviderContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IdentityProviderContractProperties", "description": "Identity Provider contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Identity Provider details." }, "IdentityProviderContractProperties": { "type": "object", "properties": { "clientId": { "type": "string", "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.", "minLength": 1 }, "clientSecret": { "x-ms-secret": true, "type": "string", "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.", "minLength": 1 } }, "allOf": [ { "$ref": "#/definitions/IdentityProviderBaseParameters" } ], "required": [ "clientId" ], "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." }, "IdentityProviderList": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IdentityProviderContract" }, "description": "Identity Provider configuration values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "List of all the Identity Providers configured on the service instance." }, "IdentityProviderUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IdentityProviderUpdateProperties", "description": "Identity Provider update properties." } }, "description": "Parameters supplied to update Identity Provider" }, "IdentityProviderUpdateProperties": { "type": "object", "properties": { "clientId": { "type": "string", "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.", "minLength": 1 }, "clientSecret": { "x-ms-secret": true, "type": "string", "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.", "minLength": 1 } }, "allOf": [ { "$ref": "#/definitions/IdentityProviderBaseParameters" } ], "description": "Parameters supplied to the Update Identity Provider operation." }, "IssueAttachmentCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IssueAttachmentContract" }, "description": "Issue Attachment values.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged Issue Attachment list representation." }, "IssueAttachmentContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IssueAttachmentContractProperties", "description": "Properties of the Issue Attachment." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Issue Attachment Contract details." }, "IssueAttachmentContractProperties": { "type": "object", "properties": { "title": { "type": "string", "description": "Filename by which the binary data will be saved." }, "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." }, "content": { "type": "string", "description": "An HTTP link or Base64-encoded binary data." } }, "required": [ "title", "contentFormat", "content" ], "description": "Issue Attachment contract Properties." }, "IssueCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IssueContract" }, "description": "Issue values.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged Issue list representation." }, "IssueCommentCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IssueCommentContract" }, "description": "Issue Comment values.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged Issue Comment list representation." }, "IssueCommentContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IssueCommentContractProperties", "description": "Properties of the Issue Comment." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Issue Comment Contract details." }, "IssueCommentContractProperties": { "type": "object", "properties": { "text": { "type": "string", "description": "Comment text." }, "createdDate": { "type": "string", "format": "date-time", "description": "Date and time when the comment was created." }, "userId": { "type": "string", "description": "A resource identifier for the user who left the comment." } }, "required": [ "text", "userId" ], "description": "Issue Comment contract Properties." }, "IssueContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IssueContractProperties", "description": "Properties of the Issue." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Issue Contract details." }, "IssueContractBaseProperties": { "type": "object", "properties": { "createdDate": { "type": "string", "format": "date-time", "description": "Date and time when the issue was created." }, "state": { "type": "string", "description": "Status of the issue.", "enum": [ "proposed", "open", "removed", "resolved", "closed" ], "x-ms-enum": { "name": "State", "modelAsString": true, "values": [ { "value": "proposed", "description": "The issue is proposed." }, { "value": "open", "description": "The issue is opened." }, { "value": "removed", "description": "The issue was removed." }, { "value": "resolved", "description": "The issue is now resolved." }, { "value": "closed", "description": "The issue was closed." } ] } }, "apiId": { "type": "string", "description": "A resource identifier for the API the issue was created for." } }, "description": "Issue contract Base Properties." }, "IssueContractProperties": { "type": "object", "properties": { "title": { "type": "string", "description": "The issue title." }, "description": { "type": "string", "description": "Text describing the issue." }, "userId": { "type": "string", "description": "A resource identifier for the user created the issue." } }, "required": [ "title", "description", "userId" ], "allOf": [ { "$ref": "#/definitions/IssueContractBaseProperties" } ], "description": "Issue contract Properties." }, "IssueUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IssueUpdateContractProperties", "description": "Issue entity Update contract properties." } }, "description": "Issue update Parameters." }, "IssueUpdateContractProperties": { "type": "object", "properties": { "title": { "type": "string", "description": "The issue title." }, "description": { "type": "string", "description": "Text describing the issue." }, "userId": { "type": "string", "description": "A resource identifier for the user created the issue." } }, "allOf": [ { "$ref": "#/definitions/IssueContractBaseProperties" } ], "description": "Issue contract Update Properties." }, "KeyVaultContractCreateProperties": { "type": "object", "properties": { "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" }, "identityClientId": { "type": "string", "description": "Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret." } }, "description": "Create keyVault contract details." }, "KeyVaultContractProperties": { "type": "object", "properties": { "lastStatus": { "$ref": "#/definitions/KeyVaultLastAccessStatusContractProperties", "description": "Last time sync and refresh status of secret from key vault." } }, "allOf": [ { "$ref": "#/definitions/KeyVaultContractCreateProperties" } ], "description": "KeyVault contract details." }, "KeyVaultLastAccessStatusContractProperties": { "type": "object", "properties": { "code": { "type": "string", "description": "Last status code for sync and refresh of secret from key vault." }, "message": { "type": "string", "description": "Details of the error else empty." }, "timeStampUtc": { "type": "string", "format": "date-time", "description": "Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" } }, "description": "Issue contract Update Properties." }, "LoggerCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/LoggerContract" }, "description": "Logger values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Logger list representation." }, "LoggerContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/LoggerContractProperties", "description": "Logger entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Logger details." }, "LoggerContractProperties": { "type": "object", "properties": { "loggerType": { "type": "string", "description": "Logger type.", "enum": [ "azureEventHub", "applicationInsights", "azureMonitor" ], "x-ms-enum": { "name": "LoggerType", "modelAsString": true, "values": [ { "value": "azureEventHub", "description": "Azure Event Hub as log destination." }, { "value": "applicationInsights", "description": "Azure Application Insights as log destination." }, { "value": "azureMonitor", "description": "Azure Monitor" } ] } }, "description": { "type": "string", "description": "Logger description.", "maxLength": 256 }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger.", "example": { "name": "apim", "connectionString": "Endpoint=sb://contoso-ns.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=..." } }, "isBuffered": { "type": "boolean", "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." }, "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." }, "LoggerUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/LoggerUpdateParameters", "description": "Logger entity update contract properties." } }, "description": "Logger update contract." }, "LoggerUpdateParameters": { "type": "object", "properties": { "loggerType": { "type": "string", "description": "Logger type.", "enum": [ "azureEventHub", "applicationInsights", "azureMonitor" ], "x-ms-enum": { "name": "LoggerType", "modelAsString": true, "values": [ { "value": "azureEventHub", "description": "Azure Event Hub as log destination." }, { "value": "applicationInsights", "description": "Azure Application Insights as log destination." }, { "value": "azureMonitor", "description": "Azure Monitor" } ] } }, "description": { "type": "string", "description": "Logger description." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Logger credentials." }, "isBuffered": { "type": "boolean", "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." } }, "description": "Parameters supplied to the Update Logger operation." }, "NotificationCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NotificationContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Notification list representation." }, "NotificationContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/NotificationContractProperties", "description": "Notification entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Notification details." }, "NotificationContractProperties": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the Notification.", "minLength": 1, "maxLength": 1000 }, "description": { "type": "string", "description": "Description of the Notification." }, "recipients": { "$ref": "#/definitions/RecipientsContractProperties", "description": "Recipient Parameter values." } }, "required": [ "title" ], "description": "Notification 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": { "openidProviderId": { "type": "string", "description": "OAuth authorization server identifier." }, "bearerTokenSendingMethods": { "description": "How to send token to the server.", "type": "array", "items": { "$ref": "#/definitions/BearerTokenSendingMethodsContract" } } }, "description": "API OAuth2 Authentication settings details." }, "OpenIdConnectProviderCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/OpenidConnectProviderContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged OpenIdProviders list representation." }, "OpenidConnectProviderContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/OpenidConnectProviderContractProperties", "description": "OpenId Connect Provider contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "OpenId Connect Provider details." }, "OpenidConnectProviderContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "User-friendly OpenID Connect Provider name.", "maxLength": 50 }, "description": { "type": "string", "description": "User-friendly description of OpenID Connect Provider." }, "metadataEndpoint": { "type": "string", "description": "Metadata endpoint URI." }, "clientId": { "type": "string", "description": "Client ID of developer console which is the client application." }, "clientSecret": { "x-ms-secret": true, "type": "string", "description": "Client Secret of developer console which is the client application." }, "useInTestConsole": { "type": "boolean", "description": "If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided." }, "useInApiDocumentation": { "type": "boolean", "description": "If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided." } }, "required": [ "displayName", "metadataEndpoint", "clientId" ], "description": "OpenID Connect Providers Contract." }, "OpenidConnectProviderUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/OpenidConnectProviderUpdateContractProperties", "description": "OpenId Connect Provider Update contract properties." } }, "description": "Parameters supplied to the Update OpenID Connect Provider operation." }, "OpenidConnectProviderUpdateContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "User-friendly OpenID Connect Provider name.", "maxLength": 50 }, "description": { "type": "string", "description": "User-friendly description of OpenID Connect Provider." }, "metadataEndpoint": { "type": "string", "description": "Metadata endpoint URI." }, "clientId": { "type": "string", "description": "Client ID of developer console which is the client application." }, "clientSecret": { "x-ms-secret": true, "type": "string", "description": "Client Secret of developer console which is the client application." }, "useInTestConsole": { "type": "boolean", "description": "If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided." }, "useInApiDocumentation": { "type": "boolean", "description": "If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided." } }, "description": "Parameters supplied to the Update OpenID Connect Provider operation." }, "OperationCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/OperationContract" }, "description": "Page values.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged Operation list representation." }, "OperationContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/OperationContractProperties", "description": "Properties of the Operation Contract." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "API Operation details." }, "OperationContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Operation Name.", "minLength": 1, "maxLength": 300 }, "method": { "type": "string", "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", "externalDocs": { "description": "As defined by RFC.", "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" } }, "urlTemplate": { "type": "string", "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", "minLength": 1, "maxLength": 1000 } }, "allOf": [ { "$ref": "#/definitions/OperationEntityBaseContract" } ], "required": [ "displayName", "method", "urlTemplate" ], "description": "Operation Contract Properties" }, "OperationEntityBaseContract": { "type": "object", "properties": { "templateParameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterContract" }, "x-ms-identifiers": [ "name", "type" ], "description": "Collection of URL template parameters." }, "description": { "type": "string", "description": "Description of the operation. May include HTML formatting tags.", "maxLength": 1000 }, "request": { "$ref": "#/definitions/RequestContract", "description": "An entity containing request details." }, "responses": { "type": "array", "items": { "$ref": "#/definitions/ResponseContract" }, "x-ms-identifiers": [], "description": "Array of Operation responses." }, "policies": { "type": "string", "description": "Operation Policies" } }, "description": "API Operation Entity Base Contract details." }, "OperationResultContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/OperationResultContractProperties", "description": "Properties of the Operation Contract." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Long Running Git Operation Results." }, "OperationResultContractProperties": { "type": "object", "properties": { "id": { "type": "string", "description": "Operation result identifier." }, "status": { "type": "string", "description": "Status of an async operation.", "enum": [ "Started", "InProgress", "Succeeded", "Failed" ], "x-ms-enum": { "name": "AsyncOperationStatus", "modelAsString": false } }, "started": { "type": "string", "format": "date-time", "description": "Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "updated": { "type": "string", "format": "date-time", "description": "Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "resultInfo": { "type": "string", "description": "Optional result info." }, "error": { "$ref": "./apimanagement.json#/definitions/ErrorResponseBody", "description": "Error Body Contract" }, "actionLog": { "type": "array", "items": { "$ref": "#/definitions/OperationResultLogItemContract" }, "x-ms-identifiers": [ "objectKey" ], "readOnly": true, "description": "This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation." } }, "description": "Operation Result." }, "OperationResultLogItemContract": { "type": "object", "properties": { "objectType": { "type": "string", "description": "The type of entity contract." }, "action": { "type": "string", "description": "Action like create/update/delete." }, "objectKey": { "type": "string", "description": "Identifier of the entity being created/updated/deleted." } }, "description": "Log of the entity being created, updated or deleted." }, "OperationTagResourceContractProperties": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the operation in form /operations/{operationId}." }, "name": { "type": "string", "description": "Operation name.", "readOnly": true }, "apiName": { "type": "string", "description": "API Name.", "readOnly": true }, "apiRevision": { "type": "string", "description": "API Revision.", "readOnly": true }, "apiVersion": { "type": "string", "description": "API Version.", "readOnly": true }, "description": { "type": "string", "description": "Operation Description.", "readOnly": true }, "method": { "type": "string", "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", "externalDocs": { "description": "As defined by RFC.", "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" }, "readOnly": true }, "urlTemplate": { "type": "string", "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", "readOnly": true } }, "description": "Operation Entity contract Properties." }, "OperationUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/OperationUpdateContractProperties", "description": "Properties of the API Operation entity that can be updated." } }, "description": "API Operation Update Contract details." }, "OperationUpdateContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Operation Name.", "minLength": 1, "maxLength": 300 }, "method": { "type": "string", "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", "externalDocs": { "description": "As defined by RFC.", "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" } }, "urlTemplate": { "type": "string", "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", "minLength": 1, "maxLength": 1000 } }, "allOf": [ { "$ref": "#/definitions/OperationEntityBaseContract" } ], "description": "Operation Update Contract Properties." }, "ParameterContract": { "type": "object", "properties": { "name": { "type": "string", "description": "Parameter name." }, "description": { "type": "string", "description": "Parameter description." }, "type": { "type": "string", "description": "Parameter type." }, "defaultValue": { "type": "string", "description": "Default parameter value." }, "required": { "type": "boolean", "description": "Specifies whether parameter is required or not." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values." }, "schemaId": { "type": "string", "description": "Schema identifier." }, "typeName": { "type": "string", "description": "Type name defined by the schema." }, "examples": { "$ref": "#/definitions/ParameterExamplesContract", "description": "Exampled defined for the parameter." } }, "required": [ "name", "type" ], "description": "Operation parameters details." }, "ParameterExamplesContract": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ParameterExampleContract", "description": "Parameter example." }, "description": "Parameter examples." }, "ParameterExampleContract": { "type": "object", "description": "Parameter example.", "properties": { "summary": { "type": "string", "description": "Short description for the example" }, "description": { "type": "string", "description": "Long description for the example" }, "value": { "description": "Example value. May be a primitive value, or an object." }, "externalValue": { "type": "string", "description": "A URL that points to the literal example" } } }, "PipelineDiagnosticSettings": { "type": "object", "properties": { "request": { "$ref": "#/definitions/HttpMessageDiagnostic", "description": "Diagnostic settings for request." }, "response": { "$ref": "#/definitions/HttpMessageDiagnostic", "description": "Diagnostic settings for response." } }, "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." }, "PolicyCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PolicyContract" }, "description": "Policy Contract value." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "The response of the list policy operation." }, "PolicyContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PolicyContractProperties", "description": "Properties of the Policy." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Policy Contract details." }, "PolicyContractProperties": { "type": "object", "properties": { "value": { "type": "string", "description": "Contents of the Policy as defined by the format." }, "format": { "type": "string", "description": "Format of the policyContent.", "enum": [ "xml", "xml-link", "rawxml", "rawxml-link" ], "x-ms-enum": { "name": "PolicyContentFormat", "modelAsString": true, "values": [ { "value": "xml", "description": "The contents are inline and Content type is an XML document." }, { "value": "xml-link", "description": "The policy XML document is hosted on a HTTP endpoint accessible from the API Management service." }, { "value": "rawxml", "description": "The contents are inline and Content type is a non XML encoded policy document." }, { "value": "rawxml-link", "description": "The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service." } ] }, "default": "xml" } }, "required": [ "value" ], "description": "Policy contract Properties." }, "PolicyWithComplianceCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PolicyWithComplianceContract" }, "description": "Policy Contract value." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "The response of the list policy operation." }, "PolicyWithComplianceContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PolicyWithComplianceContractProperties", "description": "Properties of the Policy." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Policy Contract details." }, "PolicyWithComplianceContractProperties": { "type": "object", "properties": { "referencePolicyId": { "type": "string", "description": "Policy Identifier" }, "complianceState": { "type": "string", "description": "Policy Restriction Compliance State", "enum": [ "Pending", "NonCompliant", "Compliant" ], "x-ms-enum": { "name": "PolicyComplianceState", "modelAsString": true, "values": [ { "value": "Pending", "description": "The policy restriction compliance state has not yet been determined." }, { "value": "NonCompliant", "description": "The scope in restriction is out of compliance." }, { "value": "Compliant", "description": "The scope in restriction is in compliance." } ] }, "default": "Pending" } }, "description": "Policy contract Properties." }, "PolicyDescriptionContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PolicyDescriptionContractProperties", "description": "Policy description contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Policy description details." }, "PolicyDescriptionContractProperties": { "type": "object", "properties": { "description": { "type": "string", "description": "Policy description.", "readOnly": true }, "scope": { "type": "integer", "format": "int64", "description": "Binary OR value of the Snippet scope.", "readOnly": true } }, "description": "Policy description properties." }, "PolicyDescriptionCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PolicyDescriptionContract" }, "description": "Descriptions of API Management policies." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number." } }, "description": "Descriptions of API Management policies." }, "PolicyFragmentCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PolicyFragmentContract" }, "description": "Policy fragment contract value." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "The response of the get policy fragments operation." }, "PolicyFragmentContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PolicyFragmentContractProperties", "description": "Properties of the Policy Fragment." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Policy fragment contract details." }, "PolicyFragmentContractProperties": { "type": "object", "properties": { "value": { "type": "string", "description": "Contents of the policy fragment." }, "description": { "type": "string", "description": "Policy fragment description.", "minLength": 0, "maxLength": 1000 }, "format": { "type": "string", "description": "Format of the policy fragment content.", "enum": [ "xml", "rawxml" ], "x-ms-enum": { "name": "PolicyFragmentContentFormat", "modelAsString": true, "values": [ { "value": "xml", "description": "The contents are inline and Content type is an XML document." }, { "value": "rawxml", "description": "The contents are inline and Content type is a non XML encoded policy document." } ] }, "default": "xml" }, "provisioningState": { "type": "string", "readOnly": true, "description": "The provisioning state" } }, "required": [ "value" ], "description": "Policy fragment contract properties." }, "PolicyRestrictionCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PolicyRestrictionContract" } }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "The response of the get policy restrictions operation." }, "PolicyRestrictionUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PolicyRestrictionContractProperties", "description": "Properties of the Policy Restriction." } }, "description": "Policy restriction contract details." }, "PolicyRestrictionContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PolicyRestrictionContractProperties", "description": "Properties of the Policy Restriction." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Policy restriction contract details." }, "PolicyRestrictionContractProperties": { "type": "object", "properties": { "scope": { "type": "string", "description": "Path to the policy document." }, "requireBase": { "type": "string", "description": "Indicates if base policy should be enforced for the policy document.", "enum": [ "true", "false" ], "x-ms-enum": { "name": "PolicyRestrictionRequireBase", "modelAsString": true, "values": [ { "value": "true", "description": "The policy is required to have base policy" }, { "value": "false", "description": "The policy does not require to have base policy" } ] }, "default": "false" } }, "description": "Policy restrictions contract properties." }, "AllPoliciesCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/AllPoliciesContract" }, "description": "AllPolicies Contract value." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "The response of All Policies." }, "AllPoliciesContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AllPoliciesContractProperties", "description": "Properties of the All Policies." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "AllPolicies Contract details." }, "AllPoliciesContractProperties": { "type": "object", "properties": { "referencePolicyId": { "type": "string", "description": "Policy Identifier" }, "complianceState": { "type": "string", "description": "Policy Restriction Compliance State", "enum": [ "Pending", "NonCompliant", "Compliant" ], "x-ms-enum": { "name": "PolicyComplianceState", "modelAsString": true, "values": [ { "value": "Pending", "description": "The policy restriction compliance state has not yet been determined." }, { "value": "NonCompliant", "description": "The scope in restriction is out of compliance." }, { "value": "Compliant", "description": "The scope in restriction is in compliance." } ] }, "default": "Pending" } }, "description": "AllPolicies Properties." }, "ResourceCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ] }, "description": "A collection of resources." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "A collection of resources." }, "PortalConfigCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PortalConfigContract" }, "description": "The developer portal configurations." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "The collection of the developer portal configurations." }, "PortalConfigContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PortalConfigProperties", "description": "The developer portal configuration contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "The developer portal configuration contract." }, "PortalConfigProperties": { "type": "object", "properties": { "enableBasicAuth": { "type": "boolean", "description": "Enable or disable Basic authentication method.", "default": true }, "signin": { "type": "object", "properties": { "require": { "type": "boolean", "description": "Redirect anonymous users to the sign-in page.", "default": false } } }, "signup": { "type": "object", "properties": { "termsOfService": { "type": "object", "$ref": "#/definitions/PortalConfigTermsOfServiceProperties", "description": "Terms of service settings." } } }, "delegation": { "type": "object", "$ref": "#/definitions/PortalConfigDelegationProperties", "description": "The developer portal delegation settings." }, "cors": { "type": "object", "$ref": "#/definitions/PortalConfigCorsProperties", "description": "The developer portal Cross-Origin Resource Sharing (CORS) settings." }, "csp": { "type": "object", "$ref": "#/definitions/PortalConfigCspProperties", "description": "The developer portal Content Security Policy (CSP) settings." } }, "description": "The developer portal configuration contract properties." }, "PortalConfigDelegationProperties": { "type": "object", "properties": { "delegateRegistration": { "type": "boolean", "description": "Enable or disable delegation for user registration.", "default": false }, "delegateSubscription": { "type": "boolean", "description": "Enable or disable delegation for product subscriptions.", "default": false }, "delegationUrl": { "type": "string", "description": "A delegation endpoint URL." }, "validationKey": { "x-ms-secret": true, "type": "string", "description": "A base64-encoded validation key to ensure requests originate from Azure API Management service." } } }, "PortalConfigTermsOfServiceProperties": { "type": "object", "properties": { "text": { "type": "string", "description": "A terms of service text." }, "requireConsent": { "type": "boolean", "description": "Ask user for consent to the terms of service.", "default": false } }, "description": "Terms of service contract properties." }, "PortalConfigCorsProperties": { "type": "object", "properties": { "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "Allowed origins, e.g. `https://trusted.com`." } }, "description": "The developer portal Cross-Origin Resource Sharing (CORS) settings." }, "PortalConfigCspProperties": { "type": "object", "properties": { "mode": { "type": "string", "description": "The mode of the developer portal Content Security Policy (CSP).", "enum": [ "enabled", "disabled", "reportOnly" ], "default": "disabled", "x-ms-enum": { "modelAsString": true, "name": "PortalSettingsCspMode", "values": [ { "value": "enabled", "description": "The browser will block requests not matching allowed origins." }, { "value": "disabled", "description": "The browser will not apply the origin restrictions." }, { "value": "reportOnly", "description": "The browser will report requests not matching allowed origins without blocking them." } ] } }, "reportUri": { "type": "array", "items": { "type": "string" }, "description": "The URLs used by the browser to report CSP violations." }, "allowedSources": { "type": "array", "items": { "type": "string" }, "description": "Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`." } }, "description": "The developer portal Content Security Policy (CSP) settings." }, "PortalDelegationSettings": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PortalDelegationSettingsProperties", "description": "Delegation settings contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Delegation settings for a developer portal." }, "PortalDelegationSettingsProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "A delegation Url." }, "validationKey": { "x-ms-secret": true, "type": "string", "description": "A base64-encoded validation key to validate, that a request is coming from Azure API Management." }, "subscriptions": { "$ref": "#/definitions/SubscriptionsDelegationSettingsProperties", "description": "Subscriptions delegation settings." }, "userRegistration": { "$ref": "#/definitions/RegistrationDelegationSettingsProperties", "description": "User registration delegation settings." } }, "description": "Delegation settings contract properties." }, "PortalSettingsCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PortalSettingsContract" }, "description": "Descriptions of API Management policies." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number." } }, "description": "Descriptions of API Management policies." }, "PortalSettingsContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PortalSettingsContractProperties", "description": "Portal Settings contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Portal Settings for the Developer Portal." }, "PortalSettingsContractProperties": { "type": "object", "properties": { "url": { "type": "string", "description": "A delegation Url." }, "validationKey": { "x-ms-secret": true, "type": "string", "description": "A base64-encoded validation key to validate, that a request is coming from Azure API Management." }, "subscriptions": { "$ref": "#/definitions/SubscriptionsDelegationSettingsProperties", "description": "Subscriptions delegation settings." }, "userRegistration": { "$ref": "#/definitions/RegistrationDelegationSettingsProperties", "description": "User registration delegation settings." }, "enabled": { "type": "boolean", "description": "Redirect Anonymous users to the Sign-In page." }, "termsOfService": { "type": "object", "$ref": "#/definitions/TermsOfServiceProperties", "description": "Terms of service contract properties." } }, "description": "Sign-in settings contract properties." }, "PortalSigninSettingProperties": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Redirect Anonymous users to the Sign-In page." } }, "description": "Sign-in settings contract properties." }, "PortalSigninSettings": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PortalSigninSettingProperties", "description": "Sign-in settings contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Sign-In settings for the Developer Portal." }, "PortalSignupSettings": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PortalSignupSettingsProperties", "description": "Sign-up settings contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Sign-Up settings for a developer portal." }, "PortalSignupSettingsProperties": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Allow users to sign up on a developer portal." }, "termsOfService": { "type": "object", "$ref": "#/definitions/TermsOfServiceProperties", "description": "Terms of service contract properties." } }, "description": "Sign-up settings contract properties." }, "ProductCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ProductContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Products list representation." }, "ProductContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ProductContractProperties", "description": "Product entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Product details." }, "ProductContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Product name.", "minLength": 1, "maxLength": 300 } }, "allOf": [ { "$ref": "#/definitions/ProductEntityBaseParameters" } ], "required": [ "displayName" ], "description": "Product profile." }, "ProductEntityBaseParameters": { "type": "object", "properties": { "description": { "type": "string", "description": "Product description. May include HTML formatting tags.", "minLength": 0, "maxLength": 1000 }, "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." }, "subscriptionRequired": { "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.", "type": "boolean" }, "approvalRequired": { "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.", "type": "boolean" }, "subscriptionsLimit": { "type": "integer", "format": "int32", "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." }, "state": { "type": "string", "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.", "enum": [ "notPublished", "published" ], "x-ms-enum": { "name": "ProductState", "modelAsString": false } } }, "description": "Product Entity Base Parameters" }, "ProductTagResourceContractProperties": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the product in the form of /products/{productId}" }, "name": { "type": "string", "description": "Product name.", "minLength": 1, "maxLength": 300 } }, "allOf": [ { "$ref": "./definitions.json#/definitions/ProductEntityBaseParameters" } ], "required": [ "name" ], "description": "Product profile." }, "ProductUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ProductUpdateProperties", "description": "Product entity Update contract properties." } }, "description": "Product Update parameters." }, "ProductUpdateProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Product name.", "maxLength": 300, "minLength": 1 } }, "allOf": [ { "$ref": "#/definitions/ProductEntityBaseParameters" } ], "description": "Parameters supplied to the Update Product operation." }, "NamedValueCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NamedValueContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged NamedValue list representation." }, "NamedValueCreateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/NamedValueCreateContractProperties", "description": "NamedValue entity contract properties for PUT operation." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "NamedValue details." }, "NamedValueCreateContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", "minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9-._]+$" }, "value": { "type": "string", "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.", "maxLength": 4096 }, "keyVault": { "$ref": "#/definitions/KeyVaultContractCreateProperties", "description": "KeyVault location details of the namedValue." } }, "allOf": [ { "$ref": "#/definitions/NamedValueEntityBaseParameters" } ], "required": [ "displayName" ], "description": "NamedValue Contract properties." }, "NamedValueContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/NamedValueContractProperties", "description": "NamedValue entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "NamedValue details." }, "NamedValueContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", "minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9-._]+$" }, "value": { "type": "string", "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.", "maxLength": 4096 }, "keyVault": { "$ref": "#/definitions/KeyVaultContractProperties", "description": "KeyVault location details of the namedValue." }, "provisioningState": { "type": "string", "readOnly": true, "description": "The provisioning state" } }, "allOf": [ { "$ref": "#/definitions/NamedValueEntityBaseParameters" } ], "required": [ "displayName" ], "description": "NamedValue Contract properties." }, "NamedValueEntityBaseParameters": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" }, "maxItems": 32, "description": "Optional tags that when provided can be used to filter the NamedValue list." }, "secret": { "description": "Determines whether the value is a secret and should be encrypted or not. Default value is false.", "type": "boolean" } }, "description": "NamedValue Entity Base Parameters set." }, "NamedValueUpdateParameterProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", "minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9-._]+$" }, "value": { "type": "string", "description": "Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace.", "minLength": 1, "maxLength": 4096 }, "keyVault": { "$ref": "#/definitions/KeyVaultContractCreateProperties", "description": "KeyVault location details of the namedValue." } }, "allOf": [ { "$ref": "#/definitions/NamedValueEntityBaseParameters" } ], "description": "NamedValue Contract properties." }, "NamedValueUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/NamedValueUpdateParameterProperties", "description": "NamedValue entity Update contract properties." } }, "description": "NamedValue update Parameters." }, "QuotaCounterCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/QuotaCounterContract" }, "x-ms-identifiers": [ "counterKey", "periodKey" ], "description": "Quota counter values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Quota Counter list representation." }, "QuotaCounterContract": { "type": "object", "properties": { "counterKey": { "type": "string", "description": "The Key value of the Counter. Must not be empty.", "minLength": 1 }, "periodKey": { "type": "string", "description": "Identifier of the Period for which the counter was collected. Must not be empty.", "minLength": 1 }, "periodStartTime": { "type": "string", "format": "date-time", "description": "The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "periodEndTime": { "type": "string", "format": "date-time", "description": "The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "value": { "$ref": "#/definitions/QuotaCounterValueContractProperties", "description": "Quota Value Properties" } }, "required": [ "counterKey", "periodKey", "periodStartTime", "periodEndTime" ], "description": "Quota counter details." }, "QuotaCounterValueContract": { "type": "object", "properties": { "value": { "x-ms-client-flatten": true, "$ref": "#/definitions/QuotaCounterValueContractProperties", "description": "Quota counter Value Properties." } }, "description": "Quota counter value details." }, "QuotaCounterValueContractProperties": { "type": "object", "properties": { "callsCount": { "type": "integer", "format": "int32", "description": "Number of times Counter was called." }, "kbTransferred": { "type": "number", "format": "double", "description": "Data Transferred in KiloBytes." } }, "description": "Quota counter value details." }, "QuotaCounterValueUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/QuotaCounterValueContractProperties", "description": "Quota counter value details." } }, "description": "Quota counter value details." }, "RecipientEmailCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/RecipientEmailContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Recipient User list representation." }, "RecipientEmailContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RecipientEmailContractProperties", "description": "Recipient Email contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Recipient Email details." }, "RecipientEmailContractProperties": { "type": "object", "properties": { "email": { "type": "string", "description": "User Email subscribed to notification." } }, "description": "Recipient Email Contract Properties." }, "RecipientsContractProperties": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string" }, "description": "List of Emails subscribed for the notification." }, "users": { "type": "array", "items": { "type": "string" }, "description": "List of Users subscribed for the notification." } }, "description": "Notification Parameter contract." }, "RecipientUserCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/RecipientUserContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Recipient User list representation." }, "RecipientUserContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RecipientUsersContractProperties", "description": "Recipient User entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Recipient User details." }, "RecipientUsersContractProperties": { "type": "object", "properties": { "userId": { "type": "string", "description": "API Management UserId subscribed to notification." } }, "description": "Recipient User Contract Properties." }, "RegistrationDelegationSettingsProperties": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable or disable delegation for user registration." } }, "description": "User registration delegation settings properties." }, "ReportCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ReportRecordContract" }, "x-ms-identifiers": [ "name", "userId" ], "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Report records list representation." }, "ReportRecordContract": { "type": "object", "properties": { "name": { "type": "string", "description": "Name depending on report endpoint specifies product, API, operation or developer name." }, "timestamp": { "type": "string", "format": "date-time", "description": "Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "interval": { "type": "string", "description": "Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." }, "country": { "type": "string", "description": "Country to which this record data is related." }, "region": { "type": "string", "description": "Country region to which this record data is related." }, "zip": { "type": "string", "description": "Zip code to which this record data is related." }, "userId": { "readOnly": true, "type": "string", "description": "User identifier path. /users/{userId}" }, "productId": { "readOnly": true, "type": "string", "description": "Product identifier path. /products/{productId}" }, "apiId": { "type": "string", "description": "API identifier path. /apis/{apiId}" }, "operationId": { "type": "string", "description": "Operation identifier path. /apis/{apiId}/operations/{operationId}" }, "apiRegion": { "type": "string", "description": "API region identifier." }, "subscriptionId": { "type": "string", "description": "Subscription identifier path. /subscriptions/{subscriptionId}" }, "callCountSuccess": { "type": "integer", "format": "int32", "description": "Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" }, "callCountBlocked": { "type": "integer", "format": "int32", "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" }, "callCountFailed": { "type": "integer", "format": "int32", "description": "Number of calls failed due to gateway or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600" }, "callCountOther": { "type": "integer", "format": "int32", "description": "Number of other calls." }, "callCountTotal": { "type": "integer", "format": "int32", "description": "Total number of calls." }, "bandwidth": { "type": "integer", "format": "int64", "description": "Bandwidth consumed." }, "cacheHitCount": { "type": "integer", "format": "int32", "description": "Number of times when content was served from cache policy." }, "cacheMissCount": { "type": "integer", "format": "int32", "description": "Number of times content was fetched from backend." }, "apiTimeAvg": { "type": "number", "format": "double", "description": "Average time it took to process request." }, "apiTimeMin": { "type": "number", "format": "double", "description": "Minimum time it took to process request." }, "apiTimeMax": { "type": "number", "format": "double", "description": "Maximum time it took to process request." }, "serviceTimeAvg": { "type": "number", "format": "double", "description": "Average time it took to process request on backend." }, "serviceTimeMin": { "type": "number", "format": "double", "description": "Minimum time it took to process request on backend." }, "serviceTimeMax": { "type": "number", "format": "double", "description": "Maximum time it took to process request on backend." } }, "description": "Report data." }, "RepresentationContract": { "type": "object", "properties": { "contentType": { "type": "string", "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." }, "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'." }, "formParameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterContract" }, "x-ms-identifiers": [ "name", "type" ], "description": "Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.." }, "examples": { "$ref": "#/definitions/ParameterExamplesContract", "description": "Exampled defined for the representation." } }, "required": [ "contentType" ], "description": "Operation request/response representation details." }, "RequestContract": { "type": "object", "properties": { "description": { "type": "string", "description": "Operation request description." }, "queryParameters": { "type": "array", "items": { "$ref": "#/definitions/ParameterContract" }, "x-ms-identifiers": [ "name", "type" ], "description": "Collection of operation request query parameters." }, "headers": { "type": "array", "items": { "$ref": "#/definitions/ParameterContract" }, "x-ms-identifiers": [ "name", "type" ], "description": "Collection of operation request headers." }, "representations": { "type": "array", "items": { "$ref": "#/definitions/RepresentationContract" }, "x-ms-identifiers": [], "description": "Collection of operation request representations." } }, "description": "Operation request details." }, "RequestReportCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/RequestReportRecordContract" }, "x-ms-identifiers": [ "url" ], "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." } }, "description": "Paged Report records list representation." }, "RequestReportRecordContract": { "type": "object", "properties": { "apiId": { "type": "string", "description": "API identifier path. /apis/{apiId}" }, "operationId": { "type": "string", "description": "Operation identifier path. /apis/{apiId}/operations/{operationId}" }, "productId": { "readOnly": true, "type": "string", "description": "Product identifier path. /products/{productId}" }, "userId": { "readOnly": true, "type": "string", "description": "User identifier path. /users/{userId}" }, "method": { "type": "string", "description": "The HTTP method associated with this request.." }, "url": { "type": "string", "description": "The full URL associated with this request." }, "ipAddress": { "type": "string", "description": "The client IP address associated with this request." }, "backendResponseCode": { "type": "string", "description": "The HTTP status code received by the gateway as a result of forwarding this request to the backend." }, "responseCode": { "type": "integer", "format": "int32", "description": "The HTTP status code returned by the gateway." }, "responseSize": { "type": "integer", "format": "int32", "description": "The size of the response returned by the gateway." }, "timestamp": { "type": "string", "format": "date-time", "description": "The date and time when this request was received by the gateway in ISO 8601 format." }, "cache": { "type": "string", "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend." }, "apiTime": { "type": "number", "format": "double", "description": "The total time it took to process this request." }, "serviceTime": { "type": "number", "format": "double", "description": "he time it took to forward this request to the backend and get the response back." }, "apiRegion": { "type": "string", "description": "Azure region where the gateway that processed this request is located." }, "subscriptionId": { "type": "string", "description": "Subscription identifier path. /subscriptions/{subscriptionId}" }, "requestId": { "type": "string", "description": "Request Identifier." }, "requestSize": { "type": "integer", "format": "int32", "description": "The size of this request.." } }, "description": "Request Report data." }, "ResolverCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ResolverContract" }, "description": "Page values.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged Resolver list representation." }, "ResolverContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ResolverEntityBaseContract", "description": "Properties of the Resolver Contract." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "GraphQL API Resolver details." }, "ResolverEntityBaseContract": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Resolver Name.", "minLength": 1, "maxLength": 300 }, "path": { "type": "string", "description": "Path is type/field being resolved.", "minLength": 1, "maxLength": 300 }, "description": { "type": "string", "description": "Description of the resolver. May include HTML formatting tags.", "maxLength": 1000 } }, "description": "GraphQL API Resolver Entity Base Contract details." }, "ResolverResultContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ResolverResultContractProperties", "description": "Properties of the Resolver Contract." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Long Running Git Resolver Results." }, "ResolverResultContractProperties": { "type": "object", "properties": { "id": { "type": "string", "description": "Resolver result identifier." }, "status": { "type": "string", "description": "Status of an async resolver.", "enum": [ "Started", "InProgress", "Succeeded", "Failed" ], "x-ms-enum": { "name": "AsyncResolverStatus", "modelAsString": false } }, "started": { "type": "string", "format": "date-time", "description": "Start time of an async resolver. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "updated": { "type": "string", "format": "date-time", "description": "Last update time of an async resolver. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "resultInfo": { "type": "string", "description": "Optional result info." }, "error": { "$ref": "./apimanagement.json#/definitions/ErrorResponseBody", "description": "Error Body Contract" }, "actionLog": { "type": "array", "items": { "$ref": "#/definitions/ResolverResultLogItemContract" }, "x-ms-identifiers": [ "objectKey" ], "readOnly": true, "description": "This property if only provided as part of the TenantConfiguration_Validate resolver. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy resolver." } }, "description": "Resolver Result." }, "ResolverResultLogItemContract": { "type": "object", "properties": { "objectType": { "type": "string", "description": "The type of entity contract." }, "action": { "type": "string", "description": "Action like create/update/delete." }, "objectKey": { "type": "string", "description": "Identifier of the entity being created/updated/deleted." } }, "description": "Log of the entity being created, updated or deleted." }, "ResolverUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ResolverUpdateContractProperties", "description": "Properties of the GraphQL API Resolver entity that can be updated." } }, "description": "GraphQL API Resolver Update Contract details." }, "ResolverUpdateContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Resolver Name.", "minLength": 1, "maxLength": 300 }, "path": { "type": "string", "description": "Path is type/field being resolved.", "minLength": 1, "maxLength": 300 }, "description": { "type": "string", "description": "Description of the resolver. May include HTML formatting tags.", "maxLength": 1000 } }, "description": "Resolver Update Contract Properties." }, "ResponseContract": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "description": "Operation response HTTP status code." }, "description": { "type": "string", "description": "Operation response description." }, "representations": { "type": "array", "items": { "$ref": "#/definitions/RepresentationContract" }, "x-ms-identifiers": [], "description": "Collection of operation response representations." }, "headers": { "type": "array", "items": { "$ref": "#/definitions/ParameterContract" }, "x-ms-identifiers": [ "name", "type" ], "description": "Collection of operation response headers." } }, "required": [ "statusCode" ], "description": "Operation response details." }, "SamplingSettings": { "type": "object", "properties": { "samplingType": { "type": "string", "description": "Sampling type.", "enum": [ "fixed" ], "x-ms-enum": { "name": "SamplingType", "modelAsString": true, "values": [ { "value": "fixed", "description": "Fixed-rate sampling." } ] } }, "percentage": { "type": "number", "format": "double", "minimum": 0, "maximum": 100, "description": "Rate of sampling for fixed-rate sampling." } }, "description": "Sampling settings for Diagnostic." }, "SaveConfigurationParameter": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SaveConfigurationParameterProperties", "description": "Properties of the Save Configuration Parameters." } }, "description": "Save Tenant Configuration Contract details." }, "SaveConfigurationParameterProperties": { "type": "object", "properties": { "branch": { "type": "string", "description": "The name of the Git branch in which to commit the current configuration snapshot." }, "force": { "type": "boolean", "description": "The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten." } }, "required": [ "branch" ], "description": "Parameters supplied to the Save Tenant Configuration operation." }, "SchemaCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/SchemaContract" }, "description": "API Schema Contract value.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "The response of the list schema operation." }, "SchemaContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SchemaContractProperties", "description": "Properties of the API Schema." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "API Schema Contract details." }, "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`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`." }, "document": { "x-ms-client-flatten": true, "$ref": "#/definitions/SchemaDocumentProperties", "description": "Create or update Properties of the API Schema Document." }, "provisioningState": { "type": "string", "readOnly": true, "description": "The provisioning state" } }, "required": [ "contentType", "document" ], "description": "API Schema create or update contract Properties." }, "SchemaDocumentProperties": { "type": "object", "properties": { "value": { "type": "string", "description": "Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI." }, "definitions": { "type": "object", "description": "Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise." }, "components": { "type": "object", "description": "Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise." } }, "description": "Api Schema Document Properties." }, "GlobalSchemaCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/GlobalSchemaContract" }, "description": "Global Schema Contract value.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "The response of the list schema operation." }, "GlobalSchemaContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/GlobalSchemaContractProperties", "description": "Properties of the Global Schema." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Global Schema Contract details." }, "GlobalSchemaContractProperties": { "type": "object", "properties": { "schemaType": { "type": "string", "description": "Schema Type. Immutable.", "enum": [ "xml", "json" ], "x-ms-client-name": "SchemaType", "x-ms-enum": { "name": "SchemaType", "modelAsString": true, "values": [ { "value": "xml", "description": "XML schema type.", "name": "Xml" }, { "value": "json", "description": "Json schema type.", "name": "Json" } ] } }, "description": { "type": "string", "description": "Free-form schema entity description." }, "value": { "description": "Json-encoded string for non json-based schema." }, "document": { "x-ms-client-flatten": true, "$ref": "#/definitions/GlobalSchemaDocumentProperties", "description": "Global Schema document object for json-based schema formats(e.g. json schema)." }, "provisioningState": { "type": "string", "readOnly": true, "description": "The provisioning state" } }, "required": [ "schemaType" ], "description": "Schema create or update contract Properties." }, "GlobalSchemaDocumentProperties": { "type": "object", "description": "Global Schema Document Properties." }, "SubscriptionCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/SubscriptionContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Subscriptions list representation." }, "SubscriptionContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SubscriptionContractProperties", "description": "Subscription contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Subscription details." }, "SubscriptionContractProperties": { "type": "object", "properties": { "ownerId": { "type": "string", "description": "The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier." }, "scope": { "type": "string", "description": "Scope like /products/{productId} or /apis or /apis/{apiId}." }, "displayName": { "type": "string", "description": "The name of the subscription, or null if the subscription has no name.", "minLength": 0, "maxLength": 100 }, "state": { "type": "string", "description": "Subscription 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.", "enum": [ "suspended", "active", "expired", "submitted", "rejected", "cancelled" ], "x-ms-enum": { "name": "SubscriptionState", "modelAsString": false } }, "createdDate": { "type": "string", "format": "date-time", "description": "Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n", "readOnly": true }, "startDate": { "type": "string", "format": "date-time", "description": "Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "expirationDate": { "type": "string", "format": "date-time", "description": "Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "endDate": { "type": "string", "format": "date-time", "description": "Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "notificationDate": { "type": "string", "format": "date-time", "description": "Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "primaryKey": { "x-ms-secret": true, "type": "string", "description": "Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", "minLength": 1, "maxLength": 256 }, "secondaryKey": { "x-ms-secret": true, "type": "string", "description": "Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", "minLength": 1, "maxLength": 256 }, "stateComment": { "type": "string", "description": "Optional subscription comment added by an administrator when the state is changed to the 'rejected'." }, "allowTracing": { "type": "boolean", "description": "Determines whether tracing is enabled", "x-apim-code-nillable": true } }, "required": [ "scope", "state" ], "description": "Subscription details." }, "SubscriptionCreateParameterProperties": { "type": "object", "properties": { "ownerId": { "type": "string", "description": "User (user id path) for whom subscription is being created in form /users/{userId}" }, "scope": { "type": "string", "description": "Scope like /products/{productId} or /apis or /apis/{apiId}." }, "displayName": { "type": "string", "description": "Subscription name.", "minLength": 1, "maxLength": 100 }, "primaryKey": { "type": "string", "description": "Primary subscription key. If not specified during request key will be generated automatically.", "minLength": 1, "maxLength": 256 }, "secondaryKey": { "type": "string", "description": "Secondary subscription key. If not specified during request key will be generated automatically.", "minLength": 1, "maxLength": 256 }, "state": { "type": "string", "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.", "enum": [ "suspended", "active", "expired", "submitted", "rejected", "cancelled" ], "x-ms-enum": { "name": "SubscriptionState", "modelAsString": false } }, "allowTracing": { "type": "boolean", "description": "Determines whether tracing can be enabled" } }, "required": [ "scope", "displayName" ], "description": "Parameters supplied to the Create subscription operation." }, "SubscriptionCreateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SubscriptionCreateParameterProperties", "description": "Subscription contract properties." } }, "description": "Subscription create details." }, "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.", "example": { "subscriptionKeyParameterNames": { "query": "customQueryParameterName", "header": "customHeaderParameterName" } } }, "SubscriptionsDelegationSettingsProperties": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable or disable delegation for subscriptions." } }, "description": "Subscriptions delegation settings properties." }, "SubscriptionUpdateParameterProperties": { "type": "object", "properties": { "ownerId": { "type": "string", "description": "User identifier path: /users/{userId}" }, "scope": { "type": "string", "description": "Scope like /products/{productId} or /apis or /apis/{apiId}" }, "expirationDate": { "type": "string", "format": "date-time", "description": "Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." }, "displayName": { "type": "string", "description": "Subscription name." }, "primaryKey": { "type": "string", "description": "Primary subscription key.", "minLength": 1, "maxLength": 256 }, "secondaryKey": { "type": "string", "description": "Secondary subscription key.", "minLength": 1, "maxLength": 256 }, "state": { "type": "string", "description": "Subscription 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.", "enum": [ "suspended", "active", "expired", "submitted", "rejected", "cancelled" ], "x-ms-enum": { "name": "SubscriptionState", "modelAsString": false } }, "stateComment": { "type": "string", "description": "Comments describing subscription state change by the administrator when the state is changed to the 'rejected'." }, "allowTracing": { "type": "boolean", "description": "Determines whether tracing can be enabled" } }, "description": "Parameters supplied to the Update subscription operation." }, "SubscriptionUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SubscriptionUpdateParameterProperties", "description": "Subscription Update contract properties." } }, "description": "Subscription update details." }, "TagCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/TagContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Tag list representation." }, "TagContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TagContractProperties", "description": "Tag entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Tag Contract details." }, "TagContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Tag name.", "maxLength": 160, "minLength": 1 } }, "required": [ "displayName" ], "description": "Tag contract Properties." }, "TagCreateUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TagContractProperties", "description": "Properties supplied to Create Tag operation." } }, "description": "Parameters supplied to Create/Update Tag operations." }, "TagDescriptionBaseProperties": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the Tag." }, "externalDocsUrl": { "type": "string", "description": "Absolute URL of external resources describing the tag.", "maxLength": 2000 }, "externalDocsDescription": { "type": "string", "description": "Description of the external resources describing the tag." } }, "description": "Parameters supplied to the Create TagDescription operation." }, "TagDescriptionCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/TagDescriptionContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged TagDescription list representation." }, "TagDescriptionContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TagDescriptionContractProperties", "description": "TagDescription entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Contract details." }, "TagDescriptionContractProperties": { "type": "object", "properties": { "tagId": { "type": "string", "description": "Identifier of the tag in the form of /tags/{tagId}" }, "displayName": { "type": "string", "description": "Tag name.", "maxLength": 160, "minLength": 1 } }, "allOf": [ { "$ref": "#/definitions/TagDescriptionBaseProperties" } ], "description": "TagDescription contract Properties." }, "TagDescriptionCreateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TagDescriptionBaseProperties", "description": "Properties supplied to Create TagDescription operation." } }, "description": "Parameters supplied to the Create TagDescription operation." }, "TagResourceCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/TagResourceContract" }, "x-ms-identifiers": [ "tag/id" ], "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Tag list representation." }, "TagResourceContract": { "type": "object", "properties": { "tag": { "$ref": "#/definitions/TagTagResourceContractProperties", "description": "Tag associated with the resource." }, "api": { "$ref": "#/definitions/ApiTagResourceContractProperties", "description": "API associated with the tag." }, "operation": { "$ref": "#/definitions/OperationTagResourceContractProperties", "description": "Operation associated with the tag." }, "product": { "$ref": "#/definitions/ProductTagResourceContractProperties", "description": "Product associated with the tag." } }, "required": [ "tag" ], "description": "TagResource contract properties." }, "TagTagResourceContractProperties": { "type": "object", "properties": { "id": { "type": "string", "description": "Tag identifier" }, "name": { "type": "string", "description": "Tag Name", "minLength": 1, "maxLength": 160 } }, "description": "Contract defining the Tag property in the Tag Resource Contract" }, "TenantConfigurationSyncStateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TenantConfigurationSyncStateContractProperties", "description": "Properties returned Tenant Configuration Sync State check." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Result of Tenant Configuration Sync State." }, "TenantConfigurationSyncStateContractProperties": { "type": "object", "properties": { "branch": { "type": "string", "description": "The name of Git branch." }, "commitId": { "type": "string", "description": "The latest commit Id." }, "isExport": { "type": "boolean", "description": "value indicating if last sync was save (true) or deploy (false) operation." }, "isSynced": { "type": "boolean", "description": "value indicating if last synchronization was later than the configuration change." }, "isGitEnabled": { "type": "boolean", "description": "value indicating whether Git configuration access is enabled." }, "syncDate": { "type": "string", "format": "date-time", "description": "The date of the latest synchronization. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "configurationChangeDate": { "type": "string", "format": "date-time", "description": "The date of the latest configuration change. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "lastOperationId": { "type": "string", "description": "Most recent tenant configuration operation identifier" } }, "description": "Tenant Configuration Synchronization State." }, "TermsOfServiceProperties": { "type": "object", "properties": { "text": { "type": "string", "description": "A terms of service text." }, "enabled": { "type": "boolean", "description": "Display terms of service during a sign-up process." }, "consentRequired": { "type": "boolean", "description": "Ask user for consent to the terms of service." } }, "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)." }, "UserCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/UserContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Users list representation." }, "UserContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/UserContractProperties", "description": "User entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "User details." }, "UserContractProperties": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name." }, "lastName": { "type": "string", "description": "Last name." }, "email": { "type": "string", "description": "Email address." }, "registrationDate": { "type": "string", "format": "date-time", "description": "Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" }, "groups": { "readOnly": true, "type": "array", "items": { "$ref": "./definitions.json#/definitions/GroupContractProperties" }, "x-ms-identifiers": [ "displayName" ], "description": "Collection of groups user is part of." } }, "allOf": [ { "$ref": "#/definitions/UserEntityBaseParameters" } ], "description": "User profile." }, "UserCreateParameterProperties": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address. Must not be empty and must be unique within the service instance.", "minLength": 1, "maxLength": 254 }, "firstName": { "type": "string", "description": "First name.", "minLength": 1, "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name.", "minLength": 1, "maxLength": 100 }, "password": { "type": "string", "description": "User Password. If no value is provided, a default password is generated." }, "appType": { "type": "string", "description": "Determines the type of application which send the create user request. Default is legacy portal.", "enum": [ "portal", "developerPortal" ], "x-ms-enum": { "name": "AppType", "modelAsString": true, "values": [ { "value": "portal", "description": "User create request was sent by legacy developer portal." }, { "value": "developerPortal", "description": "User create request was sent by new developer portal." } ] } }, "confirmation": { "type": "string", "description": "Determines the type of confirmation e-mail that will be sent to the newly created user.", "enum": [ "signup", "invite" ], "x-ms-enum": { "name": "Confirmation", "modelAsString": true, "values": [ { "value": "signup", "description": "Send an e-mail to the user confirming they have successfully signed up." }, { "value": "invite", "description": "Send an e-mail inviting the user to sign-up and complete registration." } ] } } }, "allOf": [ { "$ref": "#/definitions/UserEntityBaseParameters" } ], "required": [ "email", "firstName", "lastName" ], "description": "Parameters supplied to the Create User operation." }, "UserCreateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/UserCreateParameterProperties", "description": "User entity create contract properties." } }, "description": "User create details." }, "UserEntityBaseParameters": { "type": "object", "properties": { "state": { "type": "string", "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.", "enum": [ "active", "blocked", "pending", "deleted" ], "default": "active", "x-ms-enum": { "name": "UserState", "modelAsString": true, "values": [ { "value": "active", "description": "User state is active." }, { "value": "blocked", "description": "User is blocked. Blocked users cannot authenticate at developer portal or call API." }, { "value": "pending", "description": "User account is pending. Requires identity confirmation before it can be made active." }, { "value": "deleted", "description": "User account is closed. All identities and related entities are removed." } ] } }, "note": { "type": "string", "description": "Optional note about a user set by the administrator." }, "identities": { "type": "array", "items": { "$ref": "#/definitions/UserIdentityContract" }, "description": "Collection of user identities." } }, "description": "User Entity Base Parameters set." }, "UserIdentityCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/UserIdentityContract" }, "description": "User Identity values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "List of Users Identity list representation." }, "UserIdentityContract": { "type": "object", "properties": { "provider": { "type": "string", "description": "Identity provider name." }, "id": { "type": "string", "description": "Identifier value within provider." } }, "description": "User identity details." }, "UserTokenParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/UserTokenParameterProperties", "description": "User Token Parameter contract properties." } }, "description": "Get User Token parameters." }, "UserTokenParameterProperties": { "type": "object", "properties": { "keyType": { "type": "string", "description": "The Key to be used to generate token for user.", "enum": [ "primary", "secondary" ], "default": "primary", "x-ms-enum": { "name": "KeyType", "modelAsString": false } }, "expiry": { "type": "string", "format": "date-time", "description": "The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" } }, "required": [ "keyType", "expiry" ], "description": "Parameters supplied to the Get User Token operation." }, "UserTokenResult": { "type": "object", "properties": { "value": { "type": "string", "description": "Shared Access Authorization token for the User." } }, "description": "Get User Token response details." }, "UserUpdateParameters": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/UserUpdateParametersProperties", "description": "User entity update contract properties." } }, "description": "User update parameters." }, "UserUpdateParametersProperties": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address. Must not be empty and must be unique within the service instance.", "minLength": 1, "maxLength": 254 }, "password": { "type": "string", "description": "User Password." }, "firstName": { "type": "string", "description": "First name.", "minLength": 1, "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name.", "minLength": 1, "maxLength": 100 } }, "allOf": [ { "$ref": "#/definitions/UserEntityBaseParameters" } ], "description": "Parameters supplied to the Update User operation." }, "X509CertificateName": { "type": "object", "properties": { "name": { "description": "Common Name of the Certificate.", "type": "string" }, "issuerCertificateThumbprint": { "description": "Thumbprint for the Issuer of the Certificate.", "type": "string" } }, "externalDocs": { "url": "https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-windows-cluster-x509-security" }, "description": "Properties of server X509Names." }, "ClientSecretContract": { "type": "object", "properties": { "clientSecret": { "type": "string", "x-ms-secret": true, "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." } }, "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." }, "NamedValueSecretContract": { "type": "object", "properties": { "value": { "type": "string", "description": "This is secret value of the NamedValue entity." } }, "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." }, "PortalSettingValidationKeyContract": { "type": "object", "properties": { "validationKey": { "type": "string", "x-ms-secret": true, "description": "This is secret value of the validation key in portal settings." } }, "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." }, "SubscriptionKeysContract": { "type": "object", "properties": { "primaryKey": { "type": "string", "description": "Subscription primary key.", "minLength": 1, "maxLength": 256 }, "secondaryKey": { "type": "string", "description": "Subscription secondary key.", "minLength": 1, "maxLength": 256 } }, "description": "Subscription keys." }, "GatewayCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/GatewayContract" }, "description": "Page values.", "readOnly": true }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged Gateway list representation." }, "GatewayContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/GatewayContractProperties", "description": "Gateway details." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Gateway details." }, "GatewayContractProperties": { "type": "object", "properties": { "locationData": { "$ref": "#/definitions/ResourceLocationDataContract", "description": "Gateway location." }, "description": { "type": "string", "description": "Gateway description", "maxLength": 1000 } }, "description": "Properties of the Gateway contract." }, "WorkspaceLinksBaseProperties": { "type": "object", "properties": { "workspaceId": { "type": "string", "format": "arm-id", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ApiManagement/service/workspaces" } ] }, "description": "The link to the API Management service workspace." }, "gateways": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceLinksGateway" }, "description": "The array of linked gateways." } } }, "WorkspaceLinksGateway": { "type": "object", "properties": { "id": { "type": "string", "format": "arm-id", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ApiManagement/gateways" } ] }, "description": "The link to the API Management gateway." } } }, "ApiManagementWorkspaceLinksProperties": { "type": "object", "properties": {}, "allOf": [ { "$ref": "#/definitions/WorkspaceLinksBaseProperties" } ], "description": "Properties of an API Management workspaceLinks resource." }, "ApiManagementWorkspaceLinksResource": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApiManagementWorkspaceLinksProperties", "description": "Properties of the API Management WorkspaceLinks." }, "etag": { "type": "string", "description": "ETag of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "required": [ "properties" ], "description": "A single API Management WorkspaceLinks in List or Get response." }, "ApiManagementWorkspaceLinksListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApiManagementWorkspaceLinksResource" }, "description": "Result of the List API Management WorkspaceLinks operation." }, "nextLink": { "type": "string", "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." } }, "required": [ "value" ], "description": "The response of the List API Management WorkspaceLink operation." }, "ResourceLocationDataContract": { "type": "object", "properties": { "name": { "type": "string", "description": "A canonical name for the geographic or physical location.", "maxLength": 256 }, "city": { "type": "string", "description": "The city or locality where the resource is located.", "maxLength": 256 }, "district": { "type": "string", "description": "The district, state, or province where the resource is located.", "maxLength": 256 }, "countryOrRegion": { "type": "string", "description": "The country or region where the resource is located.", "maxLength": 256 } }, "required": [ "name" ], "description": "Resource location data properties." }, "GatewayKeysContract": { "type": "object", "properties": { "primary": { "type": "string", "description": "Primary gateway key." }, "secondary": { "type": "string", "description": "Secondary gateway key." } }, "description": "Gateway authentication keys." }, "GatewayTokenRequestContract": { "type": "object", "properties": { "keyType": { "type": "string", "description": "The Key to be used to generate gateway token.", "enum": [ "primary", "secondary" ], "default": "primary", "x-ms-enum": { "name": "KeyType", "modelAsString": false } }, "expiry": { "type": "string", "format": "date-time", "description": "The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" } }, "required": [ "keyType", "expiry" ], "description": "Gateway token request contract properties." }, "GatewayTokenContract": { "type": "object", "properties": { "value": { "type": "string", "description": "Shared Access Authentication token value for the Gateway." } }, "description": "Gateway access token." }, "GatewayKeyRegenerationRequestContract": { "type": "object", "properties": { "keyType": { "type": "string", "description": "The Key being regenerated.", "enum": [ "primary", "secondary" ], "x-ms-enum": { "name": "KeyType", "modelAsString": false } } }, "required": [ "keyType" ], "description": "Gateway key regeneration request contract properties." }, "GatewayHostnameConfigurationCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/GatewayHostnameConfigurationContract" }, "description": "Page values.", "readOnly": true }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged Gateway hostname configuration list representation." }, "GatewayHostnameConfigurationContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/GatewayHostnameConfigurationContractProperties", "description": "Gateway hostname configuration details." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Gateway hostname configuration details." }, "GatewayHostnameConfigurationContractProperties": { "type": "object", "properties": { "hostname": { "type": "string", "description": "Hostname value. Supports valid domain name, partial or full wildcard" }, "certificateId": { "type": "string", "description": "Identifier of Certificate entity that will be used for TLS connection establishment" }, "negotiateClientCertificate": { "type": "boolean", "description": "Determines whether gateway requests client certificate" }, "tls10Enabled": { "type": "boolean", "description": "Specifies if TLS 1.0 is supported" }, "tls11Enabled": { "type": "boolean", "description": "Specifies if TLS 1.1 is supported" }, "http2Enabled": { "type": "boolean", "description": "Specifies if HTTP/2.0 is supported" } }, "description": "Gateway hostname configuration details." }, "GatewayCertificateAuthorityCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/GatewayCertificateAuthorityContract" }, "description": "Page values.", "readOnly": true }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged Gateway certificate authority list representation." }, "GatewayCertificateAuthorityContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/GatewayCertificateAuthorityContractProperties", "description": "Gateway certificate authority details." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Gateway certificate authority details." }, "GatewayCertificateAuthorityContractProperties": { "type": "object", "properties": { "isTrusted": { "type": "boolean", "description": "Determines whether certificate authority is trusted." } }, "description": "Gateway certificate authority details." }, "AssociationContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "properties": { "provisioningState": { "type": "string", "description": "Provisioning state.", "enum": [ "created" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": false } } }, "description": "Association entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Association entity details." }, "ContentTypeCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ContentTypeContract" }, "description": "Collection of content types.", "readOnly": true }, "nextLink": { "type": "string", "description": "Next page link, if any.", "readOnly": true } }, "description": "Paged list of content types." }, "ContentTypeContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ContentTypeContractProperties", "description": "Properties of the content type." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Content type contract details." }, "ContentTypeContractProperties": { "type": "object", "properties": { "id": { "type": "string", "description": "Content type identifier" }, "name": { "type": "string", "description": "Content type name. Must be 1 to 250 characters long." }, "description": { "type": "string", "description": "Content type description." }, "schema": { "type": "object", "description": "Content type schema." }, "version": { "type": "string", "description": "Content type version." } } }, "ContentItemCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ContentItemContract" }, "description": "Collection of content items.", "readOnly": true }, "nextLink": { "type": "string", "description": "Next page link, if any.", "readOnly": true } }, "description": "Paged list of content items." }, "ContentItemContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ContentItemContractProperties", "description": "Properties of the content item." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Content type contract details." }, "ContentItemContractProperties": { "properties": {}, "additionalProperties": true }, "DeletedServicesCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/DeletedServiceContract" }, "description": "Page values.", "readOnly": true }, "nextLink": { "type": "string", "description": "Next page link if any.", "readOnly": true } }, "description": "Paged deleted API Management Services List Representation." }, "DeletedServiceContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DeletedServiceContractProperties", "description": "Deleted API Management Service details." }, "location": { "readOnly": true, "type": "string", "description": "API Management Service Master Location." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Deleted API Management Service information." }, "DeletedServiceContractProperties": { "type": "object", "properties": { "serviceId": { "type": "string", "description": "Fully-qualified API Management Service Resource ID" }, "scheduledPurgeDate": { "type": "string", "format": "date-time", "description": "UTC Date and Time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." }, "deletionDate": { "type": "string", "format": "date-time", "description": "UTC Timestamp when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." } } }, "PortalRevisionCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PortalRevisionContract" }, "description": "Collection of portal revisions.", "readOnly": true }, "nextLink": { "type": "string", "description": "Next page link, if any.", "readOnly": true } }, "description": "Paged list of portal revisions." }, "PortalRevisionContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PortalRevisionContractProperties", "description": "Properties of the portal revisions." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Portal Revision's contract details." }, "PortalRevisionContractProperties": { "type": "object", "properties": { "description": { "type": "string", "description": "Portal revision description.", "maxLength": 2000 }, "statusDetails": { "type": "string", "description": "Portal revision publishing status details.", "maxLength": 2000, "readOnly": true }, "status": { "type": "string", "description": "Status of the portal's revision.", "enum": [ "pending", "publishing", "completed", "failed" ], "x-ms-enum": { "modelAsString": true, "name": "portalRevisionStatus", "values": [ { "value": "pending", "description": "Portal's revision has been queued." }, { "value": "publishing", "description": "Portal's revision is being published." }, { "value": "completed", "description": "Portal's revision publishing completed." }, { "value": "failed", "description": "Portal's revision publishing failed." } ] }, "readOnly": true }, "isCurrent": { "type": "boolean", "description": "Indicates if the portal's revision is public." }, "createdDateTime": { "type": "string", "readOnly": true, "format": "date-time", "description": "Portal's revision creation date and time." }, "updatedDateTime": { "type": "string", "readOnly": true, "format": "date-time", "description": "Last updated date and time." }, "provisioningState": { "type": "string", "readOnly": true, "description": "The provisioning state" } } }, "PrivateEndpointConnectionRequest": { "description": "A request to approve or reject a private endpoint connection", "type": "object", "properties": { "id": { "description": "Private Endpoint Connection Resource Id.", "type": "string" }, "properties": { "type": "object", "description": "The connection state of the private endpoint connection.", "properties": { "privateLinkServiceConnectionState": { "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", "description": "A collection of information about the state of the connection between service consumer and provider." } } } } }, "RemotePrivateEndpointConnectionWrapper": { "description": "Remote Private Endpoint Connection resource.", "type": "object", "properties": { "id": { "description": "Private Endpoint connection resource id", "type": "string" }, "name": { "description": "Private Endpoint Connection Name", "type": "string" }, "type": { "description": "Private Endpoint Connection Resource Type", "type": "string" }, "properties": { "$ref": "#/definitions/PrivateEndpointConnectionWrapperProperties", "x-ms-client-flatten": true, "description": "Resource properties." } } }, "PrivateEndpointConnectionWrapperProperties": { "properties": { "privateEndpoint": { "$ref": "#/definitions/ArmIdWrapper", "description": "The resource of private end point." }, "privateLinkServiceConnectionState": { "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { "type": "string", "readOnly": true, "description": "The provisioning state of the private endpoint connection resource." }, "groupIds": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "All the Group ids." } }, "required": [ "privateLinkServiceConnectionState" ], "description": "Properties of the PrivateEndpointConnectProperties.", "type": "object" }, "ArmIdWrapper": { "description": "A wrapper for an ARM resource id", "type": "object", "properties": { "id": { "type": "string", "readOnly": true } } }, "ConnectivityCheckRequest": { "description": "A request to perform the connectivity check operation on a API Management service.", "type": "object", "required": [ "source", "destination" ], "properties": { "source": { "description": "Definitions about the connectivity check origin.", "type": "object", "required": [ "region" ], "properties": { "region": { "description": "The API Management service region from where to start the connectivity check operation.", "type": "string", "example": "westus" }, "instance": { "description": "The particular VMSS instance from which to fire the request.", "type": "integer", "format": "int64" } } }, "destination": { "description": "The connectivity check operation destination.", "type": "object", "required": [ "address", "port" ], "properties": { "address": { "description": "Destination address. Can either be an IP address or a FQDN.", "type": "string", "example": "microsoft.com" }, "port": { "description": "Destination port.", "type": "integer", "format": "int64", "example": 80 } } }, "preferredIPVersion": { "description": "The IP version to be used. Only IPv4 is supported for now.", "type": "string", "enum": [ "IPv4" ], "x-ms-enum": { "name": "PreferredIPVersion", "modelAsString": true } }, "protocol": { "description": "The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value.", "type": "string", "enum": [ "TCP", "HTTP", "HTTPS" ], "x-ms-enum": { "name": "ConnectivityCheckProtocol", "modelAsString": true } }, "protocolConfiguration": { "description": "Protocol-specific configuration.", "type": "object", "properties": { "HTTPConfiguration": { "description": "Configuration for HTTP or HTTPS requests.", "type": "object", "properties": { "method": { "description": "The HTTP method to be used.", "type": "string", "enum": [ "GET", "POST" ], "x-ms-enum": { "name": "Method", "modelAsString": true } }, "validStatusCodes": { "type": "array", "description": "List of HTTP status codes considered valid for the request response.", "items": { "type": "integer", "format": "int64" } }, "headers": { "type": "array", "description": "List of headers to be included in the request.", "items": { "$ref": "#/definitions/HTTPHeader" }, "x-ms-identifiers": [ "name" ] } } } } } } }, "HTTPHeader": { "description": "HTTP header and it's value.", "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "Header name." }, "value": { "type": "string", "description": "Header value." } } }, "ConnectivityCheckResponse": { "description": "Information on the connectivity status.", "type": "object", "properties": { "hops": { "readOnly": true, "type": "array", "description": "List of hops between the source and the destination.", "items": { "$ref": "#/definitions/ConnectivityHop" } }, "connectionStatus": { "readOnly": true, "type": "string", "enum": [ "Unknown", "Connected", "Disconnected", "Degraded" ], "x-ms-enum": { "name": "ConnectionStatus", "modelAsString": true }, "description": "The connection status." }, "avgLatencyInMs": { "description": "Average latency in milliseconds.", "readOnly": true, "type": "integer", "format": "int64" }, "minLatencyInMs": { "description": "Minimum latency in milliseconds.", "readOnly": true, "type": "integer", "format": "int64" }, "maxLatencyInMs": { "description": "Maximum latency in milliseconds.", "readOnly": true, "type": "integer", "format": "int64" }, "probesSent": { "description": "Total number of probes sent.", "readOnly": true, "type": "integer", "format": "int64" }, "probesFailed": { "description": "Number of failed probes.", "readOnly": true, "type": "integer", "format": "int64" } } }, "ConnectivityHop": { "description": "Information about a hop between the source and the destination.", "type": "object", "properties": { "type": { "description": "The type of the hop.", "readOnly": true, "type": "string" }, "id": { "description": "The ID of the hop.", "readOnly": true, "type": "string" }, "address": { "description": "The IP address of the hop.", "readOnly": true, "type": "string" }, "resourceId": { "description": "The ID of the resource corresponding to this hop.", "readOnly": true, "type": "string" }, "nextHopIds": { "readOnly": true, "type": "array", "description": "List of next hop identifiers.", "items": { "type": "string" } }, "issues": { "readOnly": true, "type": "array", "description": "List of issues.", "items": { "$ref": "#/definitions/ConnectivityIssue" }, "x-ms-identifiers": [] } } }, "ConnectivityIssue": { "description": "Information about an issue encountered in the process of checking for connectivity.", "type": "object", "properties": { "origin": { "readOnly": true, "type": "string", "enum": [ "Local", "Inbound", "Outbound" ], "x-ms-enum": { "name": "Origin", "modelAsString": true }, "description": "The origin of the issue." }, "severity": { "readOnly": true, "type": "string", "enum": [ "Error", "Warning" ], "x-ms-enum": { "name": "Severity", "modelAsString": true }, "description": "The severity of the issue." }, "type": { "readOnly": true, "type": "string", "enum": [ "Unknown", "AgentStopped", "GuestFirewall", "DnsResolution", "SocketBind", "NetworkSecurityRule", "UserDefinedRoute", "PortThrottled", "Platform" ], "x-ms-enum": { "name": "IssueType", "modelAsString": true }, "description": "The type of issue." }, "context": { "readOnly": true, "type": "array", "description": "Provides additional context on the issue.", "items": { "$ref": "#/definitions/IssueContext" }, "x-ms-identifiers": [] } } }, "IssueContext": { "description": "A key-value pair that provides additional context on the issue.", "type": "object", "additionalProperties": { "type": "string" } }, "DocumentationContractProperties": { "type": "object", "properties": { "title": { "type": "string", "description": "documentation title." }, "content": { "type": "string", "description": "Markdown documentation content." } }, "description": "Markdown documentation details." }, "DocumentationContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DocumentationContractProperties", "description": "Markdown Documentation details." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Markdown documentation details." }, "DocumentationUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DocumentationContractProperties", "description": "Markdown Documentation details." } }, "description": "Documentation update contract details." }, "WikiDocumentationContract": { "type": "object", "properties": { "documentationId": { "type": "string", "description": "Documentation Identifier" } }, "description": "Wiki documentation details." }, "WikiContractProperties": { "type": "object", "properties": { "documents": { "type": "array", "description": "Collection wiki documents included into this wiki.", "items": { "$ref": "#/definitions/WikiDocumentationContract" }, "x-ms-identifiers": [ "documentationId" ] } }, "description": "Wiki contract details" }, "WikiContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WikiContractProperties", "description": "Wiki details." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Wiki properties" }, "WikiUpdateContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WikiContractProperties", "description": "Wiki details." } }, "description": "Wiki update contract details." }, "WorkspaceCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged workspace list representation." }, "WorkspaceContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkspaceContractProperties", "description": "Workspace entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Workspace details." }, "WorkspaceContractProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of the workspace." }, "description": { "type": "string", "description": "Description of the workspace." } }, "required": [ "displayName" ], "description": "Workspace entity properties." }, "ProductApiLinkCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ProductApiLinkContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Product-API link list representation." }, "ProductApiLinkContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ProductApiLinkContractProperties", "description": "Product-API link entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Product-API link details." }, "ProductApiLinkContractProperties": { "type": "object", "properties": { "apiId": { "type": "string", "description": "Full resource Id of an API." } }, "required": [ "apiId" ], "description": "Product-API link entity properties." }, "ProductGroupLinkCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ProductGroupLinkContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Product-group link list representation." }, "ProductGroupLinkContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ProductGroupLinkContractProperties", "description": "Product-group link entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Product-group link details." }, "ProductGroupLinkContractProperties": { "type": "object", "properties": { "groupId": { "type": "string", "description": "Full resource Id of a group." } }, "required": [ "groupId" ], "description": "Product-group link entity properties." }, "TagApiLinkCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/TagApiLinkContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Tag-API link list representation." }, "TagApiLinkContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TagApiLinkContractProperties", "description": "Tag-API link entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Tag-API link details." }, "TagApiLinkContractProperties": { "type": "object", "properties": { "apiId": { "type": "string", "description": "Full resource Id of an API." } }, "required": [ "apiId" ], "description": "Tag-API link entity properties." }, "TagOperationLinkCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/TagOperationLinkContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Tag-operation link list representation." }, "TagOperationLinkContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TagOperationLinkContractProperties", "description": "Tag-API link entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Tag-operation link details." }, "TagOperationLinkContractProperties": { "type": "object", "properties": { "operationId": { "type": "string", "description": "Full resource Id of an API operation." } }, "required": [ "operationId" ], "description": "Tag-operation link entity properties." }, "TagProductLinkCollection": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/TagProductLinkContract" }, "description": "Page values." }, "count": { "type": "integer", "format": "int64", "description": "Total record count number across all pages." }, "nextLink": { "type": "string", "description": "Next page link if any." } }, "description": "Paged Tag-product link list representation." }, "TagProductLinkContract": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TagProductLinkContractProperties", "description": "Tag-API link entity contract properties." } }, "allOf": [ { "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Tag-product link details." }, "TagProductLinkContractProperties": { "type": "object", "properties": { "productId": { "type": "string", "description": "Full resource Id of a product." } }, "required": [ "productId" ], "description": "Tag-product link entity properties." }, "GatewayListDebugCredentialsContract": { "type": "object", "properties": { "credentialsExpireAfter": { "type": "string", "format": "duration", "description": "Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used." }, "purposes": { "type": "array", "description": "Purposes of debug credential.", "items": { "type": "string", "description": "Purpose of debug credential.", "enum": [ "tracing" ], "x-ms-enum": { "name": "GatewayListDebugCredentialsContractPurpose", "modelAsString": true, "values": [ { "value": "tracing", "description": "The tracing purpose." } ] } } }, "apiId": { "type": "string", "format": "arm-id", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ApiManagement/service/apis" }, { "type": "Microsoft.ApiManagement/service/workspaces/apis" } ] }, "description": "Full resource Id of an API." } }, "required": [ "purposes", "apiId" ], "description": "List debug credentials properties." }, "GatewayDebugCredentialsContract": { "type": "object", "properties": { "token": { "type": "string", "x-ms-secret": true, "description": "Gateway debug token." } }, "description": "Gateway debug credentials." }, "GatewayListTraceContract": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Trace id." } }, "description": "List trace properties." }, "GatewayTraceContract": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Trace collected in gateway." } }, "parameters": {} }