diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimanagement.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimanagement.json index 516b9bea..25fb9478 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimanagement.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimanagement.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -33,356 +33,7 @@ } } }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies": { - "get": { - "tags": [ - "Policy" - ], - "operationId": "Policy_ListByService", - "description": "Lists all the Global Policy definitions of the Api Management service.", - "x-ms-examples": { - "ApiManagementListPolicies": { - "$ref": "./examples/ApiManagementListPolicies.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "name": "scope", - "in": "query", - "required": false, - "type": "string", - "description": "Policy scope.", - "enum": [ - "Tenant", - "Product", - "Api", - "Operation", - "All" - ], - "x-ms-enum": { - "name": "PolicyScopeContract", - "modelAsString": false - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns an array of Policy Contracts.", - "schema": { - "$ref": "#/definitions/PolicyCollection" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}": { - "head": { - "tags": [ - "Policy" - ], - "operationId": "Policy_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Global policy definition in the Api Management service.", - "x-ms-examples": { - "ApiManagementHeadPolicy": { - "$ref": "./examples/ApiManagementHeadPolicy.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/PolicyIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Policy" - ], - "operationId": "Policy_Get", - "description": "Get the Global policy definition of the Api Management service.", - "x-ms-examples": { - "ApiManagementGetPolicy": { - "$ref": "./examples/ApiManagementGetPolicy.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/PolicyIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns the Policy Contracts.", - "schema": { - "$ref": "#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Policy" - ], - "operationId": "Policy_CreateOrUpdate", - "description": "Creates or updates the global policy configuration of the Api Management service.", - "x-ms-examples": { - "ApiManagementCreatePolicy": { - "$ref": "./examples/ApiManagementCreatePolicy.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/PolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "schema": { - "$ref": "#/definitions/PolicyContract" - }, - "required": true, - "description": "The policy contents to apply." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Global policy configuration was successfully created.", - "schema": { - "$ref": "#/definitions/PolicyContract" - } - }, - "200": { - "description": "Global policy configuration of the Api Management service was successfully updated.", - "schema": { - "$ref": "#/definitions/PolicyContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Policy" - ], - "operationId": "Policy_Delete", - "description": "Deletes the global policy configuration of the Api Management Service.", - "x-ms-examples": { - "ApiManagementDeletePolicy": { - "$ref": "./examples/ApiManagementDeletePolicy.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/PolicyIdParameter" - }, - { - "$ref": "#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the policy configuration at the Global level." - }, - "204": { - "description": "Successfully deleted the policy configuration at the Global level." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policySnippets": { - "get": { - "tags": [ - "PolicySnippets" - ], - "operationId": "PolicySnippets_ListByService", - "description": "Lists all policy snippets.", - "x-ms-examples": { - "ApiManagementListPolicySnippets": { - "$ref": "./examples/ApiManagementListPolicySnippets.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "name": "scope", - "in": "query", - "required": false, - "type": "string", - "description": "Policy scope.", - "enum": [ - "Tenant", - "Product", - "Api", - "Operation", - "All" - ], - "x-ms-enum": { - "name": "PolicyScopeContract", - "modelAsString": false - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns an array of Policy Contracts.", - "schema": { - "$ref": "#/definitions/PolicySnippetsCollection" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions": { - "get": { - "tags": [ - "Regions" - ], - "operationId": "Regions_ListByService", - "description": "Lists all azure regions in which the service exists.", - "x-ms-examples": { - "ApiManagementListRegions": { - "$ref": "./examples/ApiManagementListRegions.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists of Regions in which the service is deployed.", - "schema": { - "$ref": "#/definitions/RegionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, + "paths": {}, "definitions": { "ErrorFieldContract": { "properties": { @@ -402,6 +53,16 @@ "description": "Error Field contract." }, "ErrorResponse": { + "properties": { + "error": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ErrorResponseBody", + "description": "Properties of the Error Response." + } + }, + "description": "Error Response." + }, + "ErrorResponseBody": { "properties": { "code": { "type": "string", @@ -416,124 +77,15 @@ "items": { "$ref": "#/definitions/ErrorFieldContract" }, + "x-ms-identifiers": [ + "message", + "target" + ], "description": "The list of invalid fields send in request, in case of validation error." } }, "description": "Error Body contract." }, - "PolicyCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyContract" - }, - "description": "Policy Contract value." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "The response of the list policy operation." - }, - "PolicyContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PolicyContractProperties", - "description": "Properties of the Policy." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Policy Contract details." - }, - "PolicyContractProperties": { - "properties": { - "policyContent": { - "type": "string", - "description": "Json escaped Xml Encoded contents of the Policy." - }, - "contentFormat": { - "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": [ - "policyContent" - ], - "description": "Policy contract Properties." - }, - "PolicySnippetsCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicySnippetContract" - }, - "description": "Policy snippet value." - } - }, - "description": "The response of the list policy snippets operation." - }, - "PolicySnippetContract": { - "properties": { - "name": { - "type": "string", - "description": "Snippet name.", - "readOnly": true - }, - "content": { - "type": "string", - "description": "Snippet content.", - "readOnly": true - }, - "toolTip": { - "type": "string", - "description": "Snippet toolTip.", - "readOnly": true - }, - "scope": { - "type": "integer", - "description": "Binary OR value of the Snippet scope.", - "readOnly": true - } - }, - "description": "Policy snippet." - }, "RegionContract": { "properties": { "name": { @@ -559,6 +111,9 @@ "items": { "$ref": "#/definitions/RegionContract" }, + "x-ms-identifiers": [ + "name" + ], "description": "Lists of Regions." }, "count": { @@ -572,104 +127,259 @@ } }, "description": "Lists Regions operation response details." - }, - "Resource": { - "description": "The Resource definition.", - "x-ms-azure-resource": true, - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource ID." - }, - "name": { - "type": "string", - "description": "Resource name.", - "readOnly": true - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type for API Management resource." - } - } } }, "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", + "AccessParameter": { + "name": "accessName", + "in": "path", "required": true, "type": "string", - "description": "Version of the API to be used with the client request." + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AccessIdName" + }, + "description": "The identifier of the Access configuration.", + "x-ms-parameter-location": "method" }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", + "SettingsParameter": { + "name": "settingsType", "in": "path", "required": true, "type": "string", - "description": "The name of the resource group.", + "enum": [ + "public" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "settingsTypeName" + }, + "description": "The identifier of the settings.", "x-ms-parameter-location": "method" }, - "ServiceNameParameter": { - "name": "serviceName", + "ApiIdParameter": { + "name": "apiId", "in": "path", "required": true, "type": "string", - "description": "The name of the API Management service.", + "description": "API identifier. Must be unique in the current API Management service instance.", "minLength": 1, - "maxLength": 50, - "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$", - "x-ms-parameter-location": "method" - }, - "SkipQueryParameter": { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Number of records to skip.", - "minimum": 0, + "maxLength": 80, "x-ms-parameter-location": "method" }, - "SubscriptionIdParameter": { - "name": "subscriptionId", + "ApiIdRevParameter": { + "name": "apiId", "in": "path", "required": true, "type": "string", - "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" }, - "TopQueryParameter": { - "name": "$top", + "ApiVersionParameter": { + "name": "api-version", "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Number of records to return.", - "minimum": 1, - "x-ms-parameter-location": "method" + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request." }, - "PolicyIdParameter": { - "name": "policyId", + "ApiVersionSetIdParameter": { + "name": "versionSetId", "in": "path", "required": true, "type": "string", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "AppTypeParameter": { + "name": "appType", + "in": "query", + "required": false, + "type": "string", + "description": "Determines the type of application which send the create user request. Default is legacy publisher portal.", "enum": [ - "policy" + "portal", + "developerPortal" ], - "description": "The identifier of the Policy.", "x-ms-enum": { + "name": "AppType", "modelAsString": true, - "name": "PolicyIdName" - }, - "x-ms-parameter-location": "method" - }, - "IfMatchRequiredParameter": { - "name": "If-Match", - "in": "header", + "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." + } + ] + }, + "default": "portal", + "x-ms-parameter-location": "method" + }, + "AttachmentIdParameter": { + "name": "attachmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Attachment identifier within an Issue. Must be unique in the current Issue.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "AuthenticationServerIdParameter": { + "name": "authsid", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the authorization server.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "BackendIdParameter": { + "name": "backendId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "CacheIdParameter": { + "name": "cacheId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "CertificateIdParameter": { + "name": "certificateId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "CommentIdParameter": { + "name": "commentId", + "in": "path", "required": true, - "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", "type": "string", + "description": "Comment identifier within an Issue. Must be unique in the current Issue.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "ConfigurationParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "configuration" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "configurationIdName" + }, + "description": "The identifier of the Git Configuration Operation.", + "x-ms-parameter-location": "method" + }, + "DiagnosticIdParameter": { + "name": "diagnosticId", + "in": "path", + "required": true, + "type": "string", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "EmailParameter": { + "name": "email", + "in": "path", + "required": true, + "type": "string", + "description": "Email identifier.", + "x-ms-parameter-location": "method" + }, + "GroupIdParameter": { + "name": "groupId", + "in": "path", + "required": true, + "type": "string", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "x-ms-parameter-location": "method" + }, + "IdentityProviderNameParameter": { + "name": "identityProviderName", + "in": "path", + "required": true, + "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.", "x-ms-parameter-location": "method" }, "IfMatchOptionalParameter": { @@ -679,6 +389,388 @@ "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", "type": "string", "x-ms-parameter-location": "method" + }, + "IfMatchRequiredParameter": { + "name": "If-Match", + "in": "header", + "required": true, + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "IssueIdParameter": { + "name": "issueId", + "in": "path", + "required": true, + "type": "string", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "LocationNameParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US.", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "LoggerIdParameter": { + "name": "loggerId", + "in": "path", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "x-ms-parameter-location": "method" + }, + "NotificationNameParameter": { + "name": "notificationName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + }, + "description": "Notification Name Identifier.", + "x-ms-parameter-location": "method" + }, + "NotifySubscriptionStateChangeParameter": { + "name": "notify", + "in": "query", + "required": false, + "type": "boolean", + "description": "Notify change in Subscription State. \n - If false, do not send any email notification for change of state of subscription \n - If true, send email notification of change of state of subscription ", + "x-ms-parameter-location": "method" + }, + "OpenIdConnectIdParameter": { + "name": "opid", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the OpenID Connect Provider.", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "PolicyExportFormat": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "description": "Policy Export Format.", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "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", + "x-ms-parameter-location": "method" + }, + "PolicyIdParameter": { + "name": "policyId", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "description": "The identifier of the Policy.", + "x-ms-enum": { + "modelAsString": true, + "name": "PolicyIdName" + }, + "x-ms-parameter-location": "method" + }, + "PortalRevisionIdParameter": { + "name": "portalRevisionId", + "in": "path", + "required": true, + "type": "string", + "description": "Portal revision identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "x-ms-parameter-location": "method" + }, + "ProductIdParameter": { + "name": "productId", + "in": "path", + "required": true, + "type": "string", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "x-ms-parameter-location": "method" + }, + "NamedValueIdParameter": { + "name": "namedValueId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the NamedValue.", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "QuotaCounterKeyParameter": { + "name": "quotaCounterKey", + "in": "path", + "required": true, + "type": "string", + "description": "Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key=\"boo\" in the policy, then it’s accessible by \"boo\" counter key. But if it’s defined as counter-key=\"@(\"b\"+\"a\")\" then it will be accessible by \"ba\" key", + "x-ms-parameter-location": "method" + }, + "QuotaPeriodKeyParameter": { + "name": "quotaPeriodKey", + "in": "path", + "required": true, + "type": "string", + "description": "Quota period key identifier.", + "x-ms-parameter-location": "method" + }, + "ReleaseIdParameter": { + "name": "releaseId", + "in": "path", + "required": true, + "type": "string", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ServiceNameParameter": { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the API Management service.", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$", + "x-ms-parameter-location": "method" + }, + "SkipQueryParameter": { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of records to skip.", + "minimum": 0, + "x-ms-parameter-location": "method" + }, + "SubscriptionEntityIdParameter": { + "name": "sid", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "TagIdParameter": { + "name": "tagId", + "in": "path", + "required": true, + "type": "string", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "TagDescriptionIdParameter": { + "name": "tagDescriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "TemplateNameParameter": { + "name": "templateName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ], + "x-ms-enum": { + "name": "TemplateName", + "modelAsString": true + }, + "description": "Email Template Name Identifier.", + "x-ms-parameter-location": "method" + }, + "TopQueryParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of records to return.", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "UserIdParameter": { + "name": "userId", + "in": "path", + "required": true, + "type": "string", + "description": "User identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "GatewayIdParameter": { + "name": "gatewayId", + "in": "path", + "required": true, + "type": "string", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "GatewayHostnameConfigurationIdParameter": { + "name": "hcId", + "in": "path", + "required": true, + "type": "string", + "description": "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "ContentTypeIdParameter": { + "name": "contentTypeId", + "in": "path", + "required": true, + "type": "string", + "description": "Content type identifier.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "ContentItemIdParameter": { + "name": "contentItemId", + "in": "path", + "required": true, + "type": "string", + "description": "Content item identifier.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" + }, + "SchemaIdParameter": { + "name": "schemaId", + "in": "path", + "required": true, + "type": "string", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method" } } -} \ No newline at end of file +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapis.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapis.json index fcc1ee02..3e20bc1d 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapis.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapis.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on API entity and their Operations associated with your Azure API Management deployment.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis": { "get": { "tags": [ - "Apis" + "Api" ], "operationId": "Api_ListByService", "description": "Lists all APIs of the API Management service instance.", @@ -61,7 +61,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -70,25 +70,31 @@ "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "name": "tags", + "in": "query", + "required": false, + "type": "string", + "description": "Include tags in the response." }, { "name": "expandApiVersionSet", "in": "query", - "type": "boolean", "required": false, - "default": false, + "type": "boolean", "description": "Include full ApiVersionSet resource in response" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Paged Result response of Apis.", "schema": { - "$ref": "#/definitions/ApiCollection" + "$ref": "./definitions.json#/definitions/ApiCollection" } }, "default": { @@ -101,13 +107,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ApiContract" + "x-ms-odata": "./definitions.json#/definitions/ApiContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}": { "head": { "tags": [ - "Apis" + "Api" ], "operationId": "Api_GetEntityTag", "description": "Gets the entity state (Etag) version of the API specified by its identifier.", @@ -124,7 +130,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -153,20 +159,20 @@ }, "get": { "tags": [ - "Apis" + "Api" ], "operationId": "Api_Get", "description": "Gets the details of the API specified by its identifier.", "x-ms-examples": { "ApiManagementGetApiContract": { "$ref": "./examples/ApiManagementGetApiContract.json" + }, + "ApiManagementGetApiRevisionContract": { + "$ref": "./examples/ApiManagementGetApiRevision.json" } }, "produces": [ - "application/json", - "application/vnd.sun.wadl+xml", - "application/vnd.swagger.doc+json", - "application/wsdl+xml" + "application/json" ], "parameters": [ { @@ -176,7 +182,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -189,7 +195,7 @@ "200": { "description": "The response body contains the specified API entity.", "schema": { - "$ref": "#/definitions/ApiContract" + "$ref": "./definitions.json#/definitions/ApiContract" }, "headers": { "ETag": { @@ -208,11 +214,14 @@ }, "put": { "tags": [ - "Apis" + "Api" ], "operationId": "Api_CreateOrUpdate", "description": "Creates new or updates existing specified API of the API Management service instance.", "x-ms-examples": { + "ApiManagementCreateApiUsingOai3Import": { + "$ref": "./examples/ApiManagementCreateApiUsingOai3Import.json" + }, "ApiManagementCreateApiUsingSwaggerImport": { "$ref": "./examples/ApiManagementCreateApiUsingSwaggerImport.json" }, @@ -228,16 +237,28 @@ "ApiManagementCreateApi": { "$ref": "./examples/ApiManagementCreateApi.json" }, - "ApiManagementCreateApiRevision": { - "$ref": "./examples/ApiManagementCreateApiRevision.json" + "ApiManagementCreateWebSocketApi": { + "$ref": "./examples/ApiManagementCreateWebsocketApi.json" + }, + "ApiManagementCreateApiRevisionFromExistingApi": { + "$ref": "./examples/ApiManagementCreateApiRevisionFromExistingApi.json" + }, + "ApiManagementCreateApiNewVersionUsingExistingApi": { + "$ref": "./examples/ApiManagementCreateApiNewVersionUsingExistingApi.json" + }, + "ApiManagementCreateApiClone": { + "$ref": "./examples/ApiManagementCreateApiClone.json" + }, + "ApiManagementCreateApiWithOpenIdConnect": { + "$ref": "./examples/ApiManagementCreateApiWithOpenIdConnect.json" + }, + "ApiManagementCreateApiUsingImportOverrideServiceUrl": { + "$ref": "./examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json" + }, + "ApiManagementCreateGraphQLApi": { + "$ref": "./examples/ApiManagementCreateGraphQLApi.json" } }, - "consumes": [ - "application/json", - "application/vnd.sun.wadl+xml", - "application/vnd.swagger.doc+json", - "application/wsdl+xml" - ], "parameters": [ { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" @@ -246,14 +267,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ApiCreateOrUpdateParameter" + "$ref": "./definitions.json#/definitions/ApiCreateOrUpdateParameter" }, "description": "Create or update parameters." }, @@ -271,7 +292,7 @@ "201": { "description": "API was successfully created.", "schema": { - "$ref": "#/definitions/ApiContract" + "$ref": "./definitions.json#/definitions/ApiContract" }, "headers": { "ETag": { @@ -280,10 +301,13 @@ } } }, + "202": { + "description": "Request to create or update API was accepted. Location header contains the URL where the status of the long running operation can be checked." + }, "200": { "description": "API was successfully updated.", "schema": { - "$ref": "#/definitions/ApiContract" + "$ref": "./definitions.json#/definitions/ApiContract" }, "headers": { "ETag": { @@ -298,16 +322,20 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } }, "patch": { "tags": [ - "Apis" + "Api" ], "operationId": "Api_Update", "description": "Updates the specified API of the API Management service instance.", "x-ms-examples": { - "ApiManagementUpdateApi.json": { + "ApiManagementUpdateApi": { "$ref": "./examples/ApiManagementUpdateApi.json" } }, @@ -319,14 +347,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ApiUpdateContract" + "$ref": "./definitions.json#/definitions/ApiUpdateContract" }, "description": "API Update Contract parameters." }, @@ -341,8 +369,17 @@ } ], "responses": { - "204": { - "description": "The API was successfully updated." + "200": { + "description": "API was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -354,12 +391,12 @@ }, "delete": { "tags": [ - "Apis" + "Api" ], "operationId": "Api_Delete", "description": "Deletes the specified API of the API Management service instance.", "x-ms-examples": { - "ApiManagementDeleteApi.json": { + "ApiManagementDeleteApi": { "$ref": "./examples/ApiManagementDeleteApi.json" } }, @@ -371,7 +408,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { "name": "deleteRevisions", @@ -409,9 +446,9 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions": { "get": { "tags": [ - "Revisions" + "ApiRevision" ], - "operationId": "ApiRevisions_List", + "operationId": "ApiRevision_ListByService", "description": "Lists all revisions of an API.", "x-ms-examples": { "ApiManagementListApiRevisions": { @@ -426,33 +463,33 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n\r\n|apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" }, { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The operation returns a list of revision details.", "schema": { - "$ref": "#/definitions/ApiRevisionCollection" + "$ref": "./definitions.json#/definitions/ApiRevisionCollection" } }, "default": { @@ -465,15 +502,15 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ApiRevisionContract" + "x-ms-odata": "./definitions.json#/definitions/ApiRevisionContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases": { "get": { "tags": [ - "Releases" + "ApiRelease" ], - "operationId": "ApiRelease_List", + "operationId": "ApiRelease_ListByService", "description": "Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.", "x-ms-examples": { "ApiManagementListApiReleases": { @@ -488,33 +525,33 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n|notes|ge le eq ne gt lt|substringof contains startswith endswith|" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" }, { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The operation returns a list of API Releases.", "schema": { - "$ref": "#/definitions/ApiReleaseCollection" + "$ref": "./definitions.json#/definitions/ApiReleaseCollection" } }, "default": { @@ -527,13 +564,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ApiReleaseContract" + "x-ms-odata": "./definitions.json#/definitions/ApiReleaseContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}": { "head": { "tags": [ - "Releases" + "ApiRelease" ], "operationId": "ApiRelease_GetEntityTag", "description": "Returns the etag of an API release.", @@ -550,21 +587,21 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ReleaseIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "The operation returns the details of an API Release.", + "description": "Gets the entity state (Etag) version of the api release as specified by its identifier.", "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", @@ -582,7 +619,7 @@ }, "get": { "tags": [ - "Releases" + "ApiRelease" ], "operationId": "ApiRelease_Get", "description": "Returns the details of an API release.", @@ -599,23 +636,29 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ReleaseIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The operation returns the details of an API Release.", "schema": { - "$ref": "#/definitions/ApiReleaseContract" + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -628,9 +671,9 @@ }, "put": { "tags": [ - "Releases" + "ApiRelease" ], - "operationId": "ApiRelease_Create", + "operationId": "ApiRelease_CreateOrUpdate", "description": "Creates a new Release for the API.", "x-ms-examples": { "ApiManagementCreateApiRelease": { @@ -645,42 +688,57 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/ReleaseIdParameter" + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ApiReleaseContract" + "$ref": "./definitions.json#/definitions/ApiReleaseContract" }, "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Release was successfully created.", "schema": { - "$ref": "#/definitions/ApiReleaseContract" + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { "description": "Release was successfully updated.", "schema": { - "$ref": "#/definitions/ApiReleaseContract" + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { - "description": "Error response describing why the release failed.", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "./apimanagement.json#/definitions/ErrorResponse" } @@ -689,7 +747,7 @@ }, "patch": { "tags": [ - "Releases" + "ApiRelease" ], "operationId": "ApiRelease_Update", "description": "Updates the details of the release of the API specified by its identifier.", @@ -706,33 +764,42 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "#/parameters/ReleaseIdParameter" + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ApiReleaseContract" + "$ref": "./definitions.json#/definitions/ApiReleaseContract" }, "description": "API Release Update parameters." }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { - "204": { - "description": "The operation was successfully updated." + "200": { + "description": "Release was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -744,7 +811,7 @@ }, "delete": { "tags": [ - "Releases" + "ApiRelease" ], "operationId": "ApiRelease_Delete", "description": "Deletes the specified release in the API.", @@ -761,27 +828,27 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" }, { - "$ref": "#/parameters/ReleaseIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "The release was successfully deleted." + "description": "API release successfully removed" }, "204": { - "description": "The release was successfully deleted." + "description": "API release successfully removed by previous request or does not exist" }, "default": { "description": "Error response describing why the operation failed.", @@ -795,7 +862,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations": { "get": { "tags": [ - "Operations" + "ApiOperation" ], "operationId": "ApiOperation_ListByApi", "description": "Lists a collection of the operations for the specified API.", @@ -812,14 +879,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -827,6 +894,13 @@ { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, + { + "name": "tags", + "in": "query", + "required": false, + "type": "string", + "description": "Include tags in the response." + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -838,7 +912,7 @@ "200": { "description": "A collection of operation summary entities at the API level.", "schema": { - "$ref": "#/definitions/OperationCollection" + "$ref": "./definitions.json#/definitions/OperationCollection" } }, "default": { @@ -851,13 +925,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/OperationContract" + "x-ms-odata": "./definitions.json#/definitions/OperationContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}": { "head": { "tags": [ - "Operations" + "ApiOperation" ], "operationId": "ApiOperation_GetEntityTag", "description": "Gets the entity state (Etag) version of the API operation specified by its identifier.", @@ -874,10 +948,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -906,13 +980,16 @@ }, "get": { "tags": [ - "Operations" + "ApiOperation" ], "operationId": "ApiOperation_Get", "description": "Gets the details of the API Operation specified by its identifier.", "x-ms-examples": { "ApiManagementGetApiOperation": { "$ref": "./examples/ApiManagementGetApiOperation.json" + }, + "ApiManagementGetApiOperationPetStore": { + "$ref": "./examples/ApiManagementGetApiOperationPetStore.json" } }, "parameters": [ @@ -923,10 +1000,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -939,7 +1016,7 @@ "200": { "description": "The response body contains the specified Operation entity.", "schema": { - "$ref": "#/definitions/OperationContract" + "$ref": "./definitions.json#/definitions/OperationContract" }, "headers": { "ETag": { @@ -958,7 +1035,7 @@ }, "put": { "tags": [ - "Operations" + "ApiOperation" ], "operationId": "ApiOperation_CreateOrUpdate", "description": "Creates a new operation in the API or updates an existing one.", @@ -975,17 +1052,17 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OperationContract" + "$ref": "./definitions.json#/definitions/OperationContract" }, "description": "Create parameters." }, @@ -1003,13 +1080,25 @@ "201": { "description": "Operation was successfully created.", "schema": { - "$ref": "#/definitions/OperationContract" + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { "description": "Operation was successfully updated.", "schema": { - "$ref": "#/definitions/OperationContract" + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -1022,7 +1111,7 @@ }, "patch": { "tags": [ - "Operations" + "ApiOperation" ], "operationId": "ApiOperation_Update", "description": "Updates the details of the operation in the API specified by its identifier.", @@ -1039,17 +1128,17 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OperationUpdateContract" + "$ref": "./definitions.json#/definitions/OperationUpdateContract" }, "description": "API Operation Update parameters." }, @@ -1064,8 +1153,17 @@ } ], "responses": { - "204": { - "description": "The operation was successfully updated." + "200": { + "description": "Operation was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -1077,7 +1175,7 @@ }, "delete": { "tags": [ - "Operations" + "ApiOperation" ], "operationId": "ApiOperation_Delete", "description": "Deletes the specified operation in the API.", @@ -1094,10 +1192,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -1111,10 +1209,10 @@ ], "responses": { "200": { - "description": "The operation was successfully deleted." + "description": "API operation successfully removed" }, "204": { - "description": "The operation was successfully deleted." + "description": "API operation successfully removed by previous request or does not exist" }, "default": { "description": "Error response describing why the operation failed.", @@ -1128,7 +1226,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies": { "get": { "tags": [ - "ApiOperationPolicies" + "ApiOperationPolicy" ], "operationId": "ApiOperationPolicy_ListByOperation", "description": "Get the list of policy configuration at the API Operation level.", @@ -1145,10 +1243,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1161,7 +1259,7 @@ "200": { "description": "Api Operations Policy Collection.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyCollection" + "$ref": "./definitions.json#/definitions/PolicyCollection" } }, "default": { @@ -1176,7 +1274,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}": { "head": { "tags": [ - "ApiOperationPolicies" + "ApiOperationPolicy" ], "operationId": "ApiOperationPolicy_GetEntityTag", "description": "Gets the entity state (Etag) version of the API operation policy specified by its identifier.", @@ -1193,10 +1291,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" @@ -1228,7 +1326,7 @@ }, "get": { "tags": [ - "ApiOperationPolicies" + "ApiOperationPolicy" ], "operationId": "ApiOperationPolicy_Get", "description": "Get the policy configuration at the API Operation level.", @@ -1245,10 +1343,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" }, { "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" @@ -1264,7 +1365,7 @@ "200": { "description": "Api Operation Policy information.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "./definitions.json#/definitions/PolicyContract" }, "headers": { "ETag": { @@ -1283,7 +1384,7 @@ }, "put": { "tags": [ - "ApiOperationPolicies" + "ApiOperationPolicy" ], "operationId": "ApiOperationPolicy_CreateOrUpdate", "description": "Creates or updates policy configuration for the API Operation level.", @@ -1300,10 +1401,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" @@ -1311,10 +1412,10 @@ { "name": "parameters", "in": "body", + "required": true, "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "./definitions.json#/definitions/PolicyContract" }, - "required": true, "description": "The policy contents to apply." }, { @@ -1331,13 +1432,25 @@ "201": { "description": "Api Operation policy configuration was successfully created.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { "description": "Api Operation policy configuration of the tenant was successfully updated.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -1350,13 +1463,13 @@ }, "delete": { "tags": [ - "ApiOperationPolicies" + "ApiOperationPolicy" ], "operationId": "ApiOperationPolicy_Delete", "description": "Deletes the policy configuration at the Api Operation.", "x-ms-examples": { - "ApiManagementDeleteOperationPolicy": { - "$ref": "./examples/ApiManagementDeleteOperationPolicy.json" + "ApiManagementDeleteApiOperationPolicy": { + "$ref": "./examples/ApiManagementDeleteApiOperationPolicy.json" } }, "parameters": [ @@ -1367,16 +1480,16 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1387,10 +1500,10 @@ ], "responses": { "200": { - "description": "Successfully deleted the policy configuration at the API Operation level." + "description": "Policy successfully removed" }, "204": { - "description": "Successfully deleted the policy configuration at the API Operation level." + "description": "Policy successfully removed by previous request or does not exist" }, "default": { "description": "Error response describing why the operation failed.", @@ -1401,16 +1514,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags": { "get": { "tags": [ - "ApiProduct" + "ApiOperationTag" ], - "operationId": "ApiProduct_ListByApis", - "description": "Lists all Products, which the API is part of.", + "operationId": "Tag_ListByOperation", + "description": "Lists all Tags associated with the Operation.", "x-ms-examples": { - "ApiManagementGetProductsForApi": { - "$ref": "./examples/ApiManagementGetProductsForApi.json" + "ApiManagementListApiOperationTags": { + "$ref": "./examples/ApiManagementListApiOperationTags.json" } }, "parameters": [ @@ -1421,14 +1534,17 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -1445,9 +1561,9 @@ ], "responses": { "200": { - "description": "The operation returns a collection of products which have the Api entity.", + "description": "The operation returns a collection of tags associated with the Operation entity.", "schema": { - "$ref": "./apimproducts.json#/definitions/ProductCollection" + "$ref": "./definitions.json#/definitions/TagCollection" } }, "default": { @@ -1460,19 +1576,19 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "./apimproducts.json#/definitions/ProductContract" + "x-ms-odata": "./definitions.json#/definitions/TagContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}": { + "head": { "tags": [ - "ApiPolicy" + "ApiOperationTag" ], - "operationId": "ApiPolicy_ListByApi", - "description": "Get the policy configuration at the API level.", + "operationId": "Tag_GetEntityStateByOperation", + "description": "Gets the entity state version of the tag specified by its identifier.", "x-ms-examples": { - "ApiManagementListApiPolicies": { - "$ref": "./examples/ApiManagementListApiPolicies.json" + "ApiManagementHeadApiOperationTag": { + "$ref": "./examples/ApiManagementHeadApiOperationTag.json" } }, "parameters": [ @@ -1483,7 +1599,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1494,10 +1616,7 @@ ], "responses": { "200": { - "description": "Apis Policy Collection.", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyCollection" - }, + "description": "Empty response body, ETag header entity state version.", "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", @@ -1512,18 +1631,16 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}": { - "head": { + }, + "get": { "tags": [ - "ApiPolicy" + "ApiOperationTag" ], - "operationId": "ApiPolicy_GetEntityTag", - "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", + "operationId": "Tag_GetByOperation", + "description": "Get tag associated with the Operation.", "x-ms-examples": { - "ApiManagementHeadApiPolicy": { - "$ref": "./examples/ApiManagementHeadApiPolicy.json" + "ApiManagementGetApiOperationTag": { + "$ref": "./examples/ApiManagementGetApiOperationTag.json" } }, "parameters": [ @@ -1534,10 +1651,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1548,7 +1668,10 @@ ], "responses": { "200": { - "description": "Specified API Policy entity exists and current entity state version is present in the ETag header.", + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", @@ -1564,22 +1687,17 @@ } } }, - "get": { + "put": { "tags": [ - "ApiPolicy" + "ApiOperationTag" ], - "operationId": "ApiPolicy_Get", - "description": "Get the policy configuration at the API level.", + "operationId": "Tag_AssignToOperation", + "description": "Assign tag to the Operation.", "x-ms-examples": { - "ApiManagementGetApiPolicy": { - "$ref": "./examples/ApiManagementGetApiPolicy.json" + "ApiManagementCreateApiOperationTag": { + "$ref": "./examples/ApiManagementCreateApiOperationTag.json" } }, - "produces": [ - "application/json", - "application/vnd.ms-azure-apim.policy+xml", - "application/vnd.ms-azure-apim.policy.raw+xml" - ], "parameters": [ { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" @@ -1588,10 +1706,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1601,16 +1722,16 @@ } ], "responses": { + "201": { + "description": "Tag was assigned to the Operation.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, "200": { - "description": "Api Policy information.", + "description": "Tag is already assigned to the Operation.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } + "$ref": "./definitions.json#/definitions/TagContract" } }, "default": { @@ -1621,25 +1742,17 @@ } } }, - "put": { + "delete": { "tags": [ - "ApiPolicy" + "ApiOperationTag" ], - "operationId": "ApiPolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the API.", + "operationId": "Tag_DetachFromOperation", + "description": "Detach the tag from the Operation.", "x-ms-examples": { - "ApiManagementCreateApiPolicy": { - "$ref": "./examples/ApiManagementCreateApiPolicy.json" - }, - "ApiManagementCreateApiPolicyNonXmlEncoded": { - "$ref": "./examples/ApiManagementCreateApiPolicyNonXmlEncoded.json" + "ApiManagementDeleteApiOperationTag": { + "$ref": "./examples/ApiManagementDeleteApiOperationTag.json" } }, - "consumes": [ - "application/json", - "application/vnd.ms-azure-apim.policy+xml", - "application/vnd.ms-azure-apim.policy.raw+xml" - ], "parameters": [ { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" @@ -1648,22 +1761,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "name": "parameters", - "in": "body", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" - }, - "required": true, - "description": "The policy contents to apply." + "$ref": "./apimanagement.json#/parameters/OperationIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + "$ref": "./apimanagement.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1673,17 +1777,11 @@ } ], "responses": { - "201": { - "description": "Api policy configuration was successfully created.", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" - } - }, "200": { - "description": "Api policy configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" - } + "description": "Tag was successfully removed from Operation" + }, + "204": { + "description": "Tag successfully removed by previous request or does not exist in Operation" }, "default": { "description": "Error response describing why the operation failed.", @@ -1692,16 +1790,18 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products": { + "get": { "tags": [ - "ApiPolicy" + "ApiProduct" ], - "operationId": "ApiPolicy_Delete", - "description": "Deletes the policy configuration at the Api.", + "operationId": "ApiProduct_ListByApis", + "description": "Lists all Products, which the API is part of.", "x-ms-examples": { - "ApiManagementDeleteApiPolicy": { - "$ref": "./examples/ApiManagementDeleteApiPolicy.json" + "ApiManagementListApiProducts": { + "$ref": "./examples/ApiManagementListApiProducts.json" } }, "parameters": [ @@ -1712,13 +1812,20 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1729,10 +1836,10 @@ ], "responses": { "200": { - "description": "Successfully deleted the policy configuration at the API level." - }, - "204": { - "description": "Successfully deleted the policy configuration at the API level." + "description": "The operation returns a collection of products which have the Api entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductCollection" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -1740,19 +1847,23 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } - } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/ProductContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies": { "get": { "tags": [ - "ApiSchema" + "ApiPolicy" ], - "operationId": "ApiSchema_ListByApi", - "description": "Get the schema configuration at the API level.", + "operationId": "ApiPolicy_ListByApi", + "description": "Get the policy configuration at the API level.", "x-ms-examples": { - "ApiManagementListApiSchemas": { - "$ref": "./examples/ApiManagementListApiSchemas.json" + "ApiManagementListApiPolicies": { + "$ref": "./examples/ApiManagementListApiPolicies.json" } }, "parameters": [ @@ -1763,7 +1874,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1774,15 +1885,9 @@ ], "responses": { "200": { - "description": "Apis Schema Collection.", + "description": "Apis Policy Collection.", "schema": { - "$ref": "#/definitions/SchemaCollection" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } + "$ref": "./definitions.json#/definitions/PolicyCollection" } }, "default": { @@ -1791,22 +1896,19 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}": { "head": { "tags": [ - "ApiSchema" + "ApiPolicy" ], - "operationId": "ApiSchema_GetEntityTag", - "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", + "operationId": "ApiPolicy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", "x-ms-examples": { - "ApiManagementHeadApiSchema": { - "$ref": "./examples/ApiManagementHeadApiSchema.json" + "ApiManagementHeadApiPolicy": { + "$ref": "./examples/ApiManagementHeadApiPolicy.json" } }, "parameters": [ @@ -1817,10 +1919,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/SchemaIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1831,7 +1933,7 @@ ], "responses": { "200": { - "description": "Specified schema entity exists and current entity state version is present in the ETag header.", + "description": "Specified API Policy entity exists and current entity state version is present in the ETag header.", "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", @@ -1849,15 +1951,20 @@ }, "get": { "tags": [ - "ApiSchema" + "ApiPolicy" ], - "operationId": "ApiSchema_Get", - "description": "Get the schema configuration at the API level.", + "operationId": "ApiPolicy_Get", + "description": "Get the policy configuration at the API level.", "x-ms-examples": { - "ApiManagementGetApiSchema": { - "$ref": "./examples/ApiManagementGetApiSchema.json" + "ApiManagementGetApiPolicy": { + "$ref": "./examples/ApiManagementGetApiPolicy.json" } }, + "produces": [ + "application/json", + "application/vnd.ms-azure-apim.policy+xml", + "application/vnd.ms-azure-apim.policy.raw+xml" + ], "parameters": [ { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" @@ -1866,10 +1973,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, { - "$ref": "#/parameters/SchemaIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1880,9 +1990,9 @@ ], "responses": { "200": { - "description": "Api Schema information.", + "description": "Api Policy information.", "schema": { - "$ref": "#/definitions/SchemaContract" + "$ref": "./definitions.json#/definitions/PolicyContract" }, "headers": { "ETag": { @@ -1901,13 +2011,16 @@ }, "put": { "tags": [ - "ApiSchema" + "ApiPolicy" ], - "operationId": "ApiSchema_CreateOrUpdate", - "description": "Creates or updates schema configuration for the API.", + "operationId": "ApiPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the API.", "x-ms-examples": { - "ApiManagementCreateApiSchema": { - "$ref": "./examples/ApiManagementCreateApiSchema.json" + "ApiManagementCreateApiPolicy": { + "$ref": "./examples/ApiManagementCreateApiPolicy.json" + }, + "ApiManagementCreateApiPolicyNonXmlEncoded": { + "$ref": "./examples/ApiManagementCreateApiPolicyNonXmlEncoded.json" } }, "parameters": [ @@ -1918,19 +2031,19 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/SchemaIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, { "name": "parameters", "in": "body", + "required": true, "schema": { - "$ref": "#/definitions/SchemaContract" + "$ref": "./definitions.json#/definitions/PolicyContract" }, - "required": true, - "description": "The schema contents to apply." + "description": "The policy contents to apply." }, { "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" @@ -1944,15 +2057,27 @@ ], "responses": { "201": { - "description": "Api schema configuration was successfully created.", + "description": "Api policy configuration was successfully created.", "schema": { - "$ref": "#/definitions/SchemaContract" + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { - "description": "Api schema configuration of the tenant was successfully updated.", + "description": "Api policy configuration of the tenant was successfully updated.", "schema": { - "$ref": "#/definitions/SchemaContract" + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -1965,13 +2090,13 @@ }, "delete": { "tags": [ - "ApiSchema" + "ApiPolicy" ], - "operationId": "ApiSchema_Delete", - "description": "Deletes the schema configuration at the Api.", + "operationId": "ApiPolicy_Delete", + "description": "Deletes the policy configuration at the Api.", "x-ms-examples": { - "ApiManagementDeleteApiSchema": { - "$ref": "./examples/ApiManagementDeleteApiSchema.json" + "ApiManagementDeleteApiPolicy": { + "$ref": "./examples/ApiManagementDeleteApiPolicy.json" } }, "parameters": [ @@ -1982,10 +2107,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/SchemaIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -1999,10 +2124,10 @@ ], "responses": { "200": { - "description": "Successfully deleted the schema configuration at the API level." + "description": "Successfully deleted the policy configuration at the API level." }, "204": { - "description": "Successfully deleted the schema configuration at the API level." + "description": "Successfully deleted the policy configuration at the API level." }, "default": { "description": "Error response describing why the operation failed.", @@ -2013,16 +2138,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas": { "get": { "tags": [ - "ApisByTags" + "ApiSchema" ], - "operationId": "Api_ListByTags", - "description": "Lists a collection of apis associated with tags.", + "operationId": "ApiSchema_ListByApi", + "description": "Get the schema configuration at the API level.", "x-ms-examples": { - "ApiManagementListApisByTags": { - "$ref": "./examples/ApiManagementListApisByTags.json" + "ApiManagementListApiSchemas": { + "$ref": "./examples/ApiManagementListApiSchemas.json" } }, "parameters": [ @@ -2032,12 +2157,15 @@ { "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| isCurrent | eq | substringof, contains, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -2054,28 +2182,33 @@ ], "responses": { "200": { - "description": "Lists a collection of TagResource entities.", + "description": "Apis Schema Collection.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", "schema": { - "$ref": "./apimtagresources.json#/definitions/TagResourceCollection" + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - }, - "x-ms-odata": "./apimtagresources.json#/definitions/TagResourceContract" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}": { + "head": { "tags": [ - "ApiDiagnostics" + "ApiSchema" ], - "operationId": "ApiDiagnostic_ListByService", - "description": "Lists all diagnostics of an API.", + "operationId": "ApiSchema_GetEntityTag", + "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", "x-ms-examples": { - "ApiManagementListApiDiagnostics": { - "$ref": "./examples/ApiManagementListApiDiagnostics.json" + "ApiManagementHeadApiSchema": { + "$ref": "./examples/ApiManagementHeadApiSchema.json" } }, "parameters": [ @@ -2086,33 +2219,26 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Paged Result reponse of diagnostics for an API.", - "schema": { - "$ref": "./apimdiagnostics.json#/definitions/DiagnosticCollection" + "description": "Specified schema entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -2121,23 +2247,17 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "./apimdiagnostics.json#/definitions/DiagnosticContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}": { - "head": { + } + }, + "get": { "tags": [ - "ApiDiagnostics" + "ApiSchema" ], - "operationId": "ApiDiagnostic_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.", + "operationId": "ApiSchema_Get", + "description": "Get the schema configuration at the API level.", "x-ms-examples": { - "ApiManagementHeadApiDiagnostic": { - "$ref": "./examples/ApiManagementHeadApiDiagnostic.json" + "ApiManagementGetApiSchema": { + "$ref": "./examples/ApiManagementGetApiSchema.json" } }, "parameters": [ @@ -2148,10 +2268,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2162,7 +2282,10 @@ ], "responses": { "200": { - "description": "Operation completed successfully.", + "description": "Api Schema information.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", @@ -2178,15 +2301,15 @@ } } }, - "get": { + "put": { "tags": [ - "ApiDiagnostics" + "ApiSchema" ], - "operationId": "ApiDiagnostic_Get", - "description": "Gets the details of the Diagnostic for an API specified by its identifier.", + "operationId": "ApiSchema_CreateOrUpdate", + "description": "Creates or updates schema configuration for the API.", "x-ms-examples": { - "ApiManagementGetApiDiagnostic": { - "$ref": "./examples/ApiManagementGetApiDiagnostic.json" + "ApiManagementCreateApiSchema": { + "$ref": "./examples/ApiManagementCreateApiSchema.json" } }, "parameters": [ @@ -2197,10 +2320,22 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, + "description": "The schema contents to apply." }, { - "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2210,10 +2345,25 @@ } ], "responses": { + "202": { + "description": "Request to create or update Api schema was accepted." + }, + "201": { + "description": "Api schema configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, "200": { - "description": "The response body contains the specified Diagnostic entity.", + "description": "Api schema configuration of the tenant was successfully updated.", "schema": { - "$ref": "./apimdiagnostics.json#/definitions/DiagnosticContract" + "$ref": "./definitions.json#/definitions/SchemaContract" }, "headers": { "ETag": { @@ -2228,17 +2378,21 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } }, - "put": { + "delete": { "tags": [ - "ApiDiagnostics" + "ApiSchema" ], - "operationId": "ApiDiagnostic_CreateOrUpdate", - "description": "Creates a new Diagnostic for an API or updates an existing one.", + "operationId": "ApiSchema_Delete", + "description": "Deletes the schema configuration at the Api.", "x-ms-examples": { - "ApiManagementCreateApiDiagnostic": { - "$ref": "./examples/ApiManagementCreateApiDiagnostic.json" + "ApiManagementDeleteApiSchema": { + "$ref": "./examples/ApiManagementDeleteApiSchema.json" } }, "parameters": [ @@ -2249,22 +2403,20 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" }, { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./apimdiagnostics.json#/definitions/DiagnosticContract" - }, - "description": "Create parameters." + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "If true removes all references to the schema before deleting it." }, { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2274,17 +2426,11 @@ } ], "responses": { - "201": { - "description": "Diagnostic was successfully created.", - "schema": { - "$ref": "./apimdiagnostics.json#/definitions/DiagnosticContract" - } - }, "200": { - "description": "Diagnostic was successfully updated.", - "schema": { - "$ref": "./apimdiagnostics.json#/definitions/DiagnosticContract" - } + "description": "Successfully deleted the schema configuration at the API level." + }, + "204": { + "description": "Successfully deleted the schema configuration at the API level." }, "default": { "description": "Error response describing why the operation failed.", @@ -2293,16 +2439,18 @@ } } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics": { + "get": { "tags": [ - "ApiDiagnostics" + "ApiDiagnostic" ], - "operationId": "ApiDiagnostic_Update", - "description": "Updates the details of the Diagnostic for an API specified by its identifier.", + "operationId": "ApiDiagnostic_ListByService", + "description": "Lists all diagnostics of an API.", "x-ms-examples": { - "ApiManagementUpdateApiDiagnostic": { - "$ref": "./examples/ApiManagementUpdateApiDiagnostic.json" + "ApiManagementListApiDiagnostics": { + "$ref": "./examples/ApiManagementListApiDiagnostics.json" } }, "parameters": [ @@ -2313,22 +2461,20 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./apimdiagnostics.json#/definitions/DiagnosticContract" - }, - "description": "Diagnostic Update parameters." + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" }, { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2338,8 +2484,11 @@ } ], "responses": { - "204": { - "description": "The Diagnostic was successfully updated." + "200": { + "description": "Paged Result response of diagnostics for an API.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticCollection" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -2347,17 +2496,23 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } - } - }, - "delete": { + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/DiagnosticContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}": { + "head": { "tags": [ - "ApiDiagnostics" + "ApiDiagnostic" ], - "operationId": "ApiDiagnostic_Delete", - "description": "Deletes the specified Diagnostic from an API.", + "operationId": "ApiDiagnostic_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.", "x-ms-examples": { - "ApiManagementDeleteApiDiagnostic": { - "$ref": "./examples/ApiManagementDeleteApiDiagnostic.json" + "ApiManagementHeadApiDiagnostic": { + "$ref": "./examples/ApiManagementHeadApiDiagnostic.json" } }, "parameters": [ @@ -2368,13 +2523,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2385,10 +2537,13 @@ ], "responses": { "200": { - "description": "The Diagnostic was successfully deleted." - }, - "204": { - "description": "The Diagnostic was successfully deleted." + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -2397,18 +2552,16 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}/loggers": { + }, "get": { "tags": [ - "ApiDiagnosticLoggers" + "ApiDiagnostic" ], - "operationId": "ApiDiagnosticLogger_ListByService", - "description": "Lists all loggers assosiated with the specified Diagnostic of an API.", + "operationId": "ApiDiagnostic_Get", + "description": "Gets the details of the Diagnostic for an API specified by its identifier.", "x-ms-examples": { - "ApiManagementListApiDiagnosticLoggers": { - "$ref": "./examples/ApiManagementListApiDiagnosticLoggers.json" + "ApiManagementGetApiDiagnostic": { + "$ref": "./examples/ApiManagementGetApiDiagnostic.json" } }, "parameters": [ @@ -2419,36 +2572,29 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| type | eq | |" + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Paged Result reponse of loggers assigned to the specified Diagnostic.", + "description": "The response body contains the specified Diagnostic entity.", "schema": { - "$ref": "./apimloggers.json#/definitions/LoggerCollection" + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -2457,23 +2603,17 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "./apimloggers.json#/definitions/LoggerContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}/loggers/{loggerid}": { - "head": { + } + }, + "put": { "tags": [ - "ApiDiagnosticLoggers" + "ApiDiagnostic" ], - "operationId": "ApiDiagnosticLogger_CheckEntityExists", - "description": "Checks that logger entity specified by identifier is associated with the diagnostics entity.", + "operationId": "ApiDiagnostic_CreateOrUpdate", + "description": "Creates a new Diagnostic for an API or updates an existing one.", "x-ms-examples": { - "ApiManagementHeadApiDiagnosticLogger": { - "$ref": "./examples/ApiManagementHeadApiDiagnosticLogger.json" + "ApiManagementCreateApiDiagnostic": { + "$ref": "./examples/ApiManagementCreateApiDiagnostic.json" } }, "parameters": [ @@ -2484,13 +2624,22 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" }, { - "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "description": "Create parameters." }, { - "$ref": "./apimloggers.json#/parameters/LoggerIdParameter" + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2500,11 +2649,29 @@ } ], "responses": { - "204": { - "description": "Entity exists" + "201": { + "description": "Diagnostic was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, - "404": { - "description": "Entity does not exists." + "200": { + "description": "Diagnostic was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -2514,15 +2681,15 @@ } } }, - "put": { + "patch": { "tags": [ - "ApiDiagnosticLoggers" + "ApiDiagnostic" ], - "operationId": "ApiDiagnosticLogger_CreateOrUpdate", - "description": "Attaches a logger to a dignostic for an API.", + "operationId": "ApiDiagnostic_Update", + "description": "Updates the details of the Diagnostic for an API specified by its identifier.", "x-ms-examples": { - "ApiManagementCreateApiDiagnosticLogger": { - "$ref": "./examples/ApiManagementCreateApiDiagnosticLogger.json" + "ApiManagementUpdateApiDiagnostic": { + "$ref": "./examples/ApiManagementUpdateApiDiagnostic.json" } }, "parameters": [ @@ -2533,13 +2700,22 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" }, { - "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "description": "Diagnostic Update parameters." }, { - "$ref": "./apimloggers.json#/parameters/LoggerIdParameter" + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2549,16 +2725,16 @@ } ], "responses": { - "201": { - "description": "Logger was successfully attached to Diagnostic.", - "schema": { - "$ref": "./apimloggers.json#/definitions/LoggerContract" - } - }, "200": { - "description": "Logger to Diagnostic link was successfully updated.", + "description": "Diagnostic was successfully updated.", "schema": { - "$ref": "./apimloggers.json#/definitions/LoggerContract" + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -2571,13 +2747,13 @@ }, "delete": { "tags": [ - "ApiDiagnosticLoggers" + "ApiDiagnostic" ], - "operationId": "ApiDiagnosticLogger_Delete", - "description": "Deletes the specified Logger from Diagnostic for an API.", + "operationId": "ApiDiagnostic_Delete", + "description": "Deletes the specified Diagnostic from an API.", "x-ms-examples": { - "ApiManagementDeleteApiDiagnosticLogger": { - "$ref": "./examples/ApiManagementDeleteApiDiagnosticLogger.json" + "ApiManagementDeleteApiDiagnostic": { + "$ref": "./examples/ApiManagementDeleteApiDiagnostic.json" } }, "parameters": [ @@ -2588,13 +2764,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" }, { - "$ref": "./apimloggers.json#/parameters/LoggerIdParameter" + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2605,10 +2781,10 @@ ], "responses": { "200": { - "description": "The Logger was successfully detached from Diagnostic." + "description": "Diagnostic successfully removed" }, "204": { - "description": "The Logger was successfully detached from Diagnostic." + "description": "Diagnostic successfully removed by previous request or does not exist" }, "default": { "description": "Error response describing why the operation failed.", @@ -2622,10 +2798,10 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues": { "get": { "tags": [ - "ApiIssues" + "ApiIssue" ], "operationId": "ApiIssue_ListByService", - "description": "Lists all issues assosiated with the specified API.", + "description": "Lists all issues associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssues": { "$ref": "./examples/ApiManagementListApiIssues.json" @@ -2639,33 +2815,40 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| state | eq | |\n| userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
" + }, + { + "name": "expandCommentsAttachments", + "in": "query", + "required": false, + "type": "boolean", + "description": "Expand the comment attachments. " }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" }, { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Paged Result reponse of issues for the API.", + "description": "Paged Result response of issues for the API.", "schema": { - "$ref": "#/definitions/IssueCollection" + "$ref": "./definitions.json#/definitions/IssueCollection" } }, "default": { @@ -2678,13 +2861,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/IssueContract" + "x-ms-odata": "./definitions.json#/definitions/IssueContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}": { "head": { "tags": [ - "ApiIssues" + "ApiIssue" ], "operationId": "ApiIssue_GetEntityTag", "description": "Gets the entity state (Etag) version of the Issue for an API specified by its identifier.", @@ -2701,10 +2884,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2733,7 +2916,7 @@ }, "get": { "tags": [ - "ApiIssues" + "ApiIssue" ], "operationId": "ApiIssue_Get", "description": "Gets the details of the Issue for an API specified by its identifier.", @@ -2750,10 +2933,17 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "name": "expandCommentsAttachments", + "in": "query", + "required": false, + "type": "boolean", + "description": "Expand the comment attachments. " }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2766,7 +2956,7 @@ "200": { "description": "The response body contains the specified Issue entity.", "schema": { - "$ref": "#/definitions/IssueContract" + "$ref": "./definitions.json#/definitions/IssueContract" }, "headers": { "ETag": { @@ -2785,7 +2975,7 @@ }, "put": { "tags": [ - "ApiIssues" + "ApiIssue" ], "operationId": "ApiIssue_CreateOrUpdate", "description": "Creates a new Issue for an API or updates an existing one.", @@ -2802,26 +2992,22 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/IssueContract" + "$ref": "./definitions.json#/definitions/IssueContract" }, "description": "Create parameters." }, { - "name": "If-Match", - "in": "header", - "required": false, - "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", - "type": "string" + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2832,15 +3018,91 @@ ], "responses": { "201": { - "description": "Issue was successfully created.", + "description": "New api issue successfully added", + "schema": { + "$ref": "./definitions.json#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api issue successfully updated", + "schema": { + "$ref": "./definitions.json#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/IssueContract" + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } + } + } + }, + "patch": { + "tags": [ + "ApiIssue" + ], + "operationId": "ApiIssue_Update", + "description": "Updates an existing issue for an API.", + "x-ms-examples": { + "ApiManagementUpdateApiIssue": { + "$ref": "./examples/ApiManagementUpdateApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/IssueUpdateContract" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { "200": { - "description": "Issue was successfully updated.", + "description": "Api issue updated successfully.", "schema": { - "$ref": "#/definitions/IssueContract" + "$ref": "./definitions.json#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -2853,7 +3115,7 @@ }, "delete": { "tags": [ - "ApiIssues" + "ApiIssue" ], "operationId": "ApiIssue_Delete", "description": "Deletes the specified Issue from an API.", @@ -2870,17 +3132,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { - "name": "If-Match", - "in": "header", - "required": true, - "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", - "type": "string" + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2891,10 +3149,10 @@ ], "responses": { "200": { - "description": "The Issue was successfully deleted." + "description": "Issue successfully removed" }, "204": { - "description": "The Issue was successfully deleted." + "description": "Issue successfully removed by previous request or does not exist" }, "default": { "description": "Error response describing why the operation failed.", @@ -2908,10 +3166,10 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments": { "get": { "tags": [ - "ApiIssueComments" + "ApiIssueComment" ], "operationId": "ApiIssueComment_ListByService", - "description": "Lists all comments for the Issue assosiated with the specified API.", + "description": "Lists all comments for the Issue associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssueComments": { "$ref": "./examples/ApiManagementListApiIssueComments.json" @@ -2925,36 +3183,36 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" }, { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Paged Result reponse of issue comments for the API.", + "description": "Paged Result response of issue comments for the API.", "schema": { - "$ref": "#/definitions/IssueCommentCollection" + "$ref": "./definitions.json#/definitions/IssueCommentCollection" } }, "default": { @@ -2967,13 +3225,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/IssueCommentContract" + "x-ms-odata": "./definitions.json#/definitions/IssueCommentContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}": { "head": { "tags": [ - "ApiIssueComments" + "ApiIssueComment" ], "operationId": "ApiIssueComment_GetEntityTag", "description": "Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.", @@ -2990,13 +3248,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { - "$ref": "#/parameters/CommentIdParameter" + "$ref": "./apimanagement.json#/parameters/CommentIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -3025,7 +3283,7 @@ }, "get": { "tags": [ - "ApiIssueComments" + "ApiIssueComment" ], "operationId": "ApiIssueComment_Get", "description": "Gets the details of the issue Comment for an API specified by its identifier.", @@ -3042,13 +3300,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { - "$ref": "#/parameters/CommentIdParameter" + "$ref": "./apimanagement.json#/parameters/CommentIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -3061,7 +3319,7 @@ "200": { "description": "The response body contains the specified issue Comment entity.", "schema": { - "$ref": "#/definitions/IssueCommentContract" + "$ref": "./definitions.json#/definitions/IssueCommentContract" }, "headers": { "ETag": { @@ -3080,7 +3338,7 @@ }, "put": { "tags": [ - "ApiIssueComments" + "ApiIssueComment" ], "operationId": "ApiIssueComment_CreateOrUpdate", "description": "Creates a new Comment for the Issue in an API or updates an existing one.", @@ -3097,29 +3355,25 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { - "$ref": "#/parameters/CommentIdParameter" + "$ref": "./apimanagement.json#/parameters/CommentIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/IssueCommentContract" + "$ref": "./definitions.json#/definitions/IssueCommentContract" }, "description": "Create parameters." }, { - "name": "If-Match", - "in": "header", - "required": false, - "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", - "type": "string" + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -3130,15 +3384,27 @@ ], "responses": { "201": { - "description": "Issue Comment was successfully created.", + "description": "New api issue comment successfully added", "schema": { - "$ref": "#/definitions/IssueCommentContract" + "$ref": "./definitions.json#/definitions/IssueCommentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { - "description": "Issue Comment was successfully updated.", + "description": "Api issue comment successfully updated", "schema": { - "$ref": "#/definitions/IssueCommentContract" + "$ref": "./definitions.json#/definitions/IssueCommentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -3151,7 +3417,7 @@ }, "delete": { "tags": [ - "ApiIssueComments" + "ApiIssueComment" ], "operationId": "ApiIssueComment_Delete", "description": "Deletes the specified comment from an Issue.", @@ -3168,20 +3434,16 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { - "$ref": "#/parameters/CommentIdParameter" + "$ref": "./apimanagement.json#/parameters/CommentIdParameter" }, { - "name": "If-Match", - "in": "header", - "required": true, - "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", - "type": "string" + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -3192,10 +3454,10 @@ ], "responses": { "200": { - "description": "The issue Comment was successfully deleted." + "description": "Comment successfully removed" }, "204": { - "description": "The issue Comment was successfully deleted." + "description": "Comment successfully removed by previous request or does not exist" }, "default": { "description": "Error response describing why the operation failed.", @@ -3209,10 +3471,10 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments": { "get": { "tags": [ - "ApiIssueAttachments" + "ApiIssueAttachment" ], "operationId": "ApiIssueAttachment_ListByService", - "description": "Lists all comments for the Issue assosiated with the specified API.", + "description": "Lists all attachments for the Issue associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssueAttachments": { "$ref": "./examples/ApiManagementListApiIssueAttachments.json" @@ -3226,36 +3488,36 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" }, { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Paged Result reponse of issue comments for the API.", + "description": "Paged Result response of issue attachments for the API.", "schema": { - "$ref": "#/definitions/IssueAttachmentCollection" + "$ref": "./definitions.json#/definitions/IssueAttachmentCollection" } }, "default": { @@ -3268,13 +3530,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/IssueAttachmentContract" + "x-ms-odata": "./definitions.json#/definitions/IssueAttachmentContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}": { "head": { "tags": [ - "ApiIssueAttachments" + "ApiIssueAttachment" ], "operationId": "ApiIssueAttachment_GetEntityTag", "description": "Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.", @@ -3291,13 +3553,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { - "$ref": "#/parameters/AttachmentIdParameter" + "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -3326,7 +3588,7 @@ }, "get": { "tags": [ - "ApiIssueAttachments" + "ApiIssueAttachment" ], "operationId": "ApiIssueAttachment_Get", "description": "Gets the details of the issue Attachment for an API specified by its identifier.", @@ -3343,13 +3605,13 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { - "$ref": "#/parameters/AttachmentIdParameter" + "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -3362,7 +3624,7 @@ "200": { "description": "The response body contains the specified issue Attachment entity.", "schema": { - "$ref": "#/definitions/IssueAttachmentContract" + "$ref": "./definitions.json#/definitions/IssueAttachmentContract" }, "headers": { "ETag": { @@ -3381,7 +3643,7 @@ }, "put": { "tags": [ - "ApiIssueAttachments" + "ApiIssueAttachment" ], "operationId": "ApiIssueAttachment_CreateOrUpdate", "description": "Creates a new Attachment for the Issue in an API or updates an existing one.", @@ -3398,29 +3660,25 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { - "$ref": "#/parameters/AttachmentIdParameter" + "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/IssueAttachmentContract" + "$ref": "./definitions.json#/definitions/IssueAttachmentContract" }, "description": "Create parameters." }, { - "name": "If-Match", - "in": "header", - "required": false, - "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", - "type": "string" + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -3431,15 +3689,27 @@ ], "responses": { "201": { - "description": "Issue Attachment was successfully created.", + "description": "New api issue attachment successfully added", "schema": { - "$ref": "#/definitions/IssueAttachmentContract" + "$ref": "./definitions.json#/definitions/IssueAttachmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { - "description": "Issue Attachment was successfully updated.", + "description": "Api issue attachment successfully updated", "schema": { - "$ref": "#/definitions/IssueAttachmentContract" + "$ref": "./definitions.json#/definitions/IssueAttachmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -3452,7 +3722,7 @@ }, "delete": { "tags": [ - "ApiIssueAttachments" + "ApiIssueAttachment" ], "operationId": "ApiIssueAttachment_Delete", "description": "Deletes the specified comment from an Issue.", @@ -3469,20 +3739,16 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/IssueIdParameter" + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" }, { - "$ref": "#/parameters/AttachmentIdParameter" + "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" }, { - "name": "If-Match", - "in": "header", - "required": true, - "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", - "type": "string" + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -3493,10 +3759,10 @@ ], "responses": { "200": { - "description": "The issue Attachment was successfully deleted." + "description": "Attachment successfully removed" }, "204": { - "description": "The issue Attachment was successfully deleted." + "description": "Attachment successfully removed by previous request or does not exist" }, "default": { "description": "Error response describing why the operation failed.", @@ -3506,19 +3772,17 @@ } } } - } - }, - "x-ms-paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?export=true": { + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions": { "get": { "tags": [ - "Apis" + "ApiTagDescription" ], - "operationId": "ApiExport_Get", - "description": "Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.", + "operationId": "ApiTagDescription_ListByService", + "description": "Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations", "x-ms-examples": { - "ApiManagementGetApiExportInOpenApi2dot0": { - "$ref": "./examples/ApiManagementGetApiExportInOpenApi2dot0.json" + "ApiManagementListApiTagDescriptions": { + "$ref": "./examples/ApiManagementListApiTagDescriptions.json" } }, "parameters": [ @@ -3529,54 +3793,20 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdRevParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { - "name": "format", + "name": "$filter", "in": "query", - "required": true, + "required": false, "type": "string", - "enum": [ - "swagger-link", - "wadl-link", - "wsdl-link" - ], - "x-ms-enum": { - "name": "ExportFormat", - "modelAsString": true, - "values": [ - { - "value": "swagger-link", - "description": "Export the Api Definition in OpenApi Specification 2.0 format to the Storage Blob.", - "name": "Swagger" - }, - { - "value": "wsdl-link", - "description": "Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`", - "name": "Wsdl" - }, - { - "value": "wadl-link", - "description": "Export the Api Definition in WADL Schema to Storage Blob.", - "name": "Wadl" - } - ] - }, - "description": "Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes." + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { - "name": "export", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "ExportApi" - }, - "description": "Query parameter required to export the API details." + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -3587,9 +3817,9 @@ ], "responses": { "200": { - "description": "The response contains a stream with a full set of API metadata and includes API entity with an embedded array of operation entities.", + "description": "The operation returns a collection of tagDescriptions associated with the Api entity.", "schema": { - "$ref": "#/definitions/ApiExportResult" + "$ref": "./definitions.json#/definitions/TagDescriptionCollection" } }, "default": { @@ -3598,1162 +3828,695 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } - } - } - } - }, - "definitions": { - "ApiExportResult": { - "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 Blob Uri." - }, - "ApiCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiContract" - }, - "description": "Page values.", - "readOnly": true }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Api list representation." - }, - "ApiContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiContractProperties", - "description": "Api entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "API details." - }, - "ApiCreateOrUpdateParameter": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiCreateOrUpdateProperties", - "description": "Api entity create of update properties." - } - }, - "description": "API Create or Update Parameters." - }, - "ApiCreateOrUpdateProperties": { - "properties": { - "contentValue": { - "type": "string", - "description": "Content value when Importing an API." + "x-ms-pageable": { + "nextLinkName": "nextLink" }, - "contentFormat": { - "type": "string", - "description": "Format of the Content in which the API is getting imported.", - "enum": [ - "wadl-xml", - "wadl-link-json", - "swagger-json", - "swagger-link-json", - "wsdl", - "wsdl-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 Document." - }, - { - "value": "swagger-link-json", - "description": "The Open Api 2.0 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." - } - ] + "x-ms-odata": "./definitions.json#/definitions/TagDescriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}": { + "head": { + "tags": [ + "ApiTagDescription" + ], + "operationId": "ApiTagDescription_GetEntityTag", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiTagDescription": { + "$ref": "./examples/ApiManagementHeadApiTagDescription.json" } }, - "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" - } + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } - }, - "apiType": { - "type": "string", - "description": "Type of Api to create. \n * `http` creates a SOAP to REST API \n * `soap` creates a SOAP pass-through API .", - "enum": [ - "http", - "soap" - ], - "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" + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApiContractProperties" - } - ], - "description": "Api Create or Update Properties." - }, - "ApiContractProperties": { - "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": 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" - ], - "x-ms-enum": { - "name": "Protocol", - "modelAsString": false } }, - "description": "Describes on which protocols the operations in this API can be invoked." - }, - "apiVersionSet": { - "$ref": "#/definitions/ApiVersionSetContractDetails" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApiEntityBaseContract" - } - ], - "required": [ - "path" - ], - "description": "Api Entity Properties" - }, - "ApiUpdateContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiContractUpdateProperties", - "description": "Properties of the API entity that can be updated." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } }, - "description": "API update contract details." - }, - "ApiContractUpdateProperties": { - "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 + "get": { + "tags": [ + "ApiTagDescription" + ], + "operationId": "ApiTagDescription_Get", + "description": "Get Tag description in scope of API", + "x-ms-examples": { + "ApiManagementGetApiTagDescription": { + "$ref": "./examples/ApiManagementGetApiTagDescription.json" + } }, - "protocols": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "http", - "https" - ], - "x-ms-enum": { - "name": "Protocol", - "modelAsString": false + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the description of the tag specified by its identifier in scope if the Api.", + "schema": { + "$ref": "./definitions.json#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, - "description": "Describes on which protocols the operations in this API can be invoked." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApiEntityBaseContract" - } - ], - "description": "API update contract properties." - }, - "ApiEntityBaseContract": { - "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" - ], - "x-ms-client-name": "ApiType", - "x-ms-enum": { - "name": "ApiType", - "modelAsString": true + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } - }, - "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.", - "readOnly": true - }, - "isOnline": { - "type": "boolean", - "description": "Indicates if API revision is accessible via the gateway.", - "readOnly": true - }, - "apiVersionSetId": { - "type": "string", - "description": "A resource identifier for the related ApiVersionSet." - } - }, - "description": "API base contract details." - }, - "ApiRevisionCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiRevisionContract" - }, - "description": "Page values.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Api Revision list representation." - }, - "ApiRevisionContract": { - "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": { - "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" - } - } - }, - "ApiVersionSetContractDetails": { - "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." - }, - "description": { - "type": "string", - "description": "Description of API Version Set." - }, - "versioningScheme": { - "type": "string", - "description": "An value that determines where the API Version identifer will be located in a HTTP request.", - "enum": [ - "Segment", - "Query", - "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`." - } - } - }, - "ApiReleaseCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiReleaseContract" - }, - "description": "Page values.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Api Revision list representation." - }, - "ApiReleaseContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiReleaseContractProperties", - "description": "Properties of the Api Release Contract." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Api Release details." - }, - "ApiReleaseContractProperties": { - "description": "API Release details", - "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" - } - } - }, - "AuthenticationSettingsContract": { - "properties": { - "oAuth2": { - "$ref": "#/definitions/OAuth2AuthenticationSettingsContract", - "description": "OAuth2 Authentication settings" - } - }, - "description": "API Authentication Settings." - }, - "OAuth2AuthenticationSettingsContract": { - "properties": { - "authorizationServerId": { - "type": "string", - "description": "OAuth authorization server identifier." - }, - "scope": { - "type": "string", - "description": "operations scope." } }, - "description": "API OAuth2 Authentication settings details." - }, - "OperationCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/OperationContract" - }, - "description": "Page values.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Operation list representation." - }, - "OperationContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OperationContractProperties", - "description": "Properties of the Operation Contract." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Api Operation details." - }, - "OperationContractProperties": { - "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" + "put": { + "tags": [ + "ApiTagDescription" + ], + "operationId": "ApiTagDescription_CreateOrUpdate", + "description": "Create/Update tag description in scope of the Api.", + "x-ms-examples": { + "ApiManagementCreateApiTagDescription": { + "$ref": "./examples/ApiManagementCreateApiTagDescription.json" } }, - "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" - }, - "OperationUpdateContractProperties": { - "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" + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/TagDescriptionCreateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } - }, - "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." - }, - "OperationEntityBaseContract": { - "properties": { - "templateParameters": { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - }, - "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" + "201": { + "description": "Tag Description was created for the Api.", + "schema": { + "$ref": "./definitions.json#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, - "description": "Array of Operation responses." - }, - "policies": { - "type": "string", - "description": "Operation Policies" - } - }, - "description": "Api Operation Entity Base Contract details." - }, - "OperationUpdateContract": { - "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." - }, - "ParameterContract": { - "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": "whether parameter is required or not." - }, - "values": { - "type": "array", - "items": { - "type": "string" + "200": { + "description": "Tag Description was updated for the Api.", + "schema": { + "$ref": "./definitions.json#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, - "description": "Parameter values." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } }, - "required": [ - "name", - "type" - ], - "description": "Operation parameters details." - }, - "RepresentationContract": { - "properties": { - "contentType": { - "type": "string", - "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." - }, - "sample": { - "type": "string", - "description": "An example of the representation." - }, - "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'." + "delete": { + "tags": [ + "ApiTagDescription" + ], + "operationId": "ApiTagDescription_Delete", + "description": "Delete tag description for the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiTagDescription": { + "$ref": "./examples/ApiManagementDeleteApiTagDescription.json" + } }, - "formParameters": { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" }, - "description": "Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.." - } - }, - "required": [ - "contentType" - ], - "description": "Operation request/response representation details." - }, - "RequestContract": { - "properties": { - "description": { - "type": "string", - "description": "Operation request description." - }, - "queryParameters": { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, - "description": "Collection of operation request query parameters." - }, - "headers": { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, - "description": "Collection of operation request headers." - }, - "representations": { - "type": "array", - "items": { - "$ref": "#/definitions/RepresentationContract" + { + "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" }, - "description": "Collection of operation request representations." - } - }, - "description": "Operation request details." - }, - "ResponseContract": { - "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" + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" }, - "description": "Collection of operation response representations." - }, - "headers": { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, - "description": "Collection of operation response headers." - } - }, - "required": [ - "statusCode" - ], - "description": "Operation response details." - }, - "SubscriptionKeyParameterNamesContract": { - "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" + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Tag description successfully removed" + }, + "204": { + "description": "Tag description successfully removed by previous request or does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } } }, - "SchemaCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SchemaContract" - }, - "description": "Api Schema Contract value.", - "readOnly": true + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags": { + "get": { + "tags": [ + "ApiTag" + ], + "operationId": "Tag_ListByApi", + "description": "Lists all Tags associated with the API.", + "x-ms-examples": { + "ApiManagementListApiTags": { + "$ref": "./examples/ApiManagementListApiTags.json" + } }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "The response of the list schema operation." - }, - "SchemaContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SchemaContractProperties", - "description": "Properties of the Schema." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Schema Contract details." - }, - "SchemaContractProperties": { - "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)." + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Api entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } }, - "document": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SchemaDocumentProperties", - "description": "Properties of the Schema Document." - } - }, - "required": [ - "contentType" - ], - "description": "Schema contract Properties." - }, - "SchemaDocumentProperties": { - "properties": { - "value": { - "type": "string", - "description": "Json escaped string defining the document representing the Schema." - } - }, - "description": "Schema Document Properties." - }, - "IssueCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IssueContract" - }, - "description": "Issue values.", - "readOnly": true + "x-ms-pageable": { + "nextLinkName": "nextLink" }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Issue list representation." - }, - "IssueContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IssueContractProperties", - "description": "Properties of the Issue." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Issue Contract details." + "x-ms-odata": "./definitions.json#/definitions/TagContract" + } }, - "IssueContractProperties": { - "properties": { - "title": { - "type": "string", - "description": "The issue title." - }, - "description": { - "type": "string", - "description": "Text describing the issue." - }, - "createdDate": { - "type":"string", - "format": "date-time", - "description": "Date and time when the issue was created." + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}": { + "head": { + "tags": [ + "ApiTag" + ], + "operationId": "Tag_GetEntityStateByApi", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiTag": { + "$ref": "./examples/ApiManagementHeadApiTag.json" + } }, - "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." + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" } - ] + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } - }, - "userId": { - "type": "string", - "description": "A resource identifier for the user created the issue." - }, - "apiId": { - "type": "string", - "description": "A resource identifier for the API the issue was created for." } }, - "required": [ - "title", - "description", - "userId" - ], - "description": "Issue contract Properties." - }, - "IssueCommentCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IssueCommentContract" - }, - "description": "Issue Comment values.", - "readOnly": true + "get": { + "tags": [ + "ApiTag" + ], + "operationId": "Tag_GetByApi", + "description": "Get tag associated with the API.", + "x-ms-examples": { + "ApiManagementGetApiTag": { + "$ref": "./examples/ApiManagementGetApiTag.json" + } }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Issue Comment list representation." - }, - "IssueCommentContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IssueCommentContractProperties", - "description": "Properties of the Issue Comment." + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Issue Comment Contract details." - }, - "IssueCommentContractProperties": { - "properties": { - "text": { - "type": "string", - "description": "Comment text." - }, - "createdDate": { - "type":"string", - "format": "date-time", - "description": "Date and time when the comment was created." + "put": { + "tags": [ + "ApiTag" + ], + "operationId": "Tag_AssignToApi", + "description": "Assign tag to the Api.", + "x-ms-examples": { + "ApiManagementCreateApiTag": { + "$ref": "./examples/ApiManagementCreateApiTag.json" + } }, - "userId": { - "type": "string", - "description": "A resource identifier for the user who left the comment." + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Api.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Tag is already assigned to the Api.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } }, - "required": [ - "text", - "userId" - ], - "description": "Issue Comment contract Properties." - }, - "IssueAttachmentCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IssueAttachmentContract" - }, - "description": "Issue Attachment values.", - "readOnly": true + "delete": { + "tags": [ + "ApiTag" + ], + "operationId": "Tag_DetachFromApi", + "description": "Detach the tag from the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiTag": { + "$ref": "./examples/ApiManagementDeleteApiTag.json" + } }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Issue Attachment list representation." - }, - "IssueAttachmentContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IssueAttachmentContractProperties", - "description": "Properties of the Issue Attachment." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API/Tag association successfully removed" + }, + "204": { + "description": "API/Tag association successfully removed by previous request or does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } - ], - "description": "Issue Attachment Contract details." + } }, - "IssueAttachmentContractProperties": { - "properties": { - "title": { - "type": "string", - "description": "Filename by which the binary data will be saved." + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags": { + "get": { + "tags": [ + "ApiOperationsByTag" + ], + "operationId": "Operation_ListByTags", + "description": "Lists a collection of operations associated with tags.", + "x-ms-examples": { + "ApiManagementListApiOperationsByTags": { + "$ref": "./examples/ApiManagementListApiOperationsByTags.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "includeNotTaggedOperations", + "in": "query", + "required": false, + "type": "boolean", + "description": "Include not tagged Operations." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TagResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } }, - "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." + "x-ms-pageable": { + "nextLinkName": "nextLink" }, - "content": { - "type": "string", - "description": "An HTTP link or Base64-encoded binary data." - } - }, - "required": [ - "title", - "contentFormat", - "content" - ], - "description": "Issue Attachment contract Properties." + "x-ms-odata": "./definitions.json#/definitions/TagResourceContract" + } } }, - "parameters": { - "ApiIdParameter": { - "name": "apiId", - "in": "path", - "required": true, - "type": "string", - "description": "API identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - }, - "ApiIdRevParameter": { - "name": "apiId", - "in": "path", - "required": true, - "type": "string", - "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "OperationIdParameter": { - "name": "operationId", - "in": "path", - "required": true, - "type": "string", - "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - }, - "SchemaIdParameter": { - "name": "schemaId", - "in": "path", - "required": true, - "type": "string", - "description": "Schema identifier within an API. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - }, - "ReleaseIdParameter": { - "name": "releaseId", - "in": "path", - "required": true, - "type": "string", - "description": "Release identifier within an API. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - }, - "IssueIdParameter": { - "name": "issueId", - "in": "path", - "required": true, - "type": "string", - "description": "Issue identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "CommentIdParameter": { - "name": "commentId", - "in": "path", - "required": true, - "type": "string", - "description": "Comment identifier within an Issue. Must be unique in the current Issue.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "AttachmentIdParameter": { - "name": "attachmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Attachment identifier within an Issue. Must be unique in the current Issue.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" + "x-ms-paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?export=true": { + "get": { + "tags": [ + "Apis" + ], + "operationId": "ApiExport_Get", + "description": "Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.", + "x-ms-examples": { + "ApiManagementGetApiExportInOpenApi2dot0": { + "$ref": "./examples/ApiManagementGetApiExportInOpenApi2dot0.json" + }, + "ApiManagementGetApiExportInOpenApi3dot0": { + "$ref": "./examples/ApiManagementGetApiExportInOpenApi3dot0.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" + }, + { + "name": "format", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "swagger-link", + "wadl-link", + "wsdl-link", + "openapi-link", + "openapi+json-link" + ], + "x-ms-enum": { + "name": "ExportFormat", + "modelAsString": true, + "values": [ + { + "value": "swagger-link", + "description": "Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob.", + "name": "Swagger" + }, + { + "value": "wsdl-link", + "description": "Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`", + "name": "Wsdl" + }, + { + "value": "wadl-link", + "description": "Export the Api Definition in WADL Schema to Storage Blob.", + "name": "Wadl" + }, + { + "value": "openapi-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob.", + "name": "Openapi" + }, + { + "value": "openapi+json-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob.", + "name": "OpenapiJson" + } + ] + }, + "description": "Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes." + }, + { + "name": "export", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "true" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ExportApi" + }, + "description": "Query parameter required to export the API details." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response contains a stream with a full set of API metadata and includes API entity with an embedded array of operation entities.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiExportResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } } - } -} \ No newline at end of file + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapisByTags.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapisByTags.json new file mode 100644 index 00000000..08ac1691 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapisByTags.json @@ -0,0 +1,106 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing retrieve a collection of Apis associated with a tag in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags": { + "get": { + "tags": [ + "ApisByTag" + ], + "operationId": "Api_ListByTags", + "description": "Lists a collection of apis associated with tags.", + "x-ms-examples": { + "ApiManagementListApisByTags": { + "$ref": "./examples/ApiManagementListApisByTags.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "includeNotTaggedApis", + "in": "query", + "required": false, + "type": "boolean", + "description": "Include not tagged APIs." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TagResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/TagResourceContract" + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapiversionsets.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapiversionsets.json new file mode 100644 index 00000000..d915a642 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapiversionsets.json @@ -0,0 +1,376 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on the ApiVersionSet entity associated with your Azure API Management deployment. Using this entity you create and manage API Version Sets that are used to group APIs for consistent versioning.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets": { + "get": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "ApiVersionSet_ListByService", + "description": "Lists a collection of API Version Sets in the specified service instance.", + "x-ms-examples": { + "ApiManagementListApiVersionSets": { + "$ref": "./examples/ApiManagementListApiVersionSets.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Api Version Set entities.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/ApiVersionSetContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}": { + "head": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "ApiVersionSet_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Api Version Set specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiVersionSet": { + "$ref": "./examples/ApiManagementHeadApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Api Version Set entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "ApiVersionSet_Get", + "description": "Gets the details of the Api Version Set specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiVersionSet": { + "$ref": "./examples/ApiManagementGetApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the specified Api Version Set entity.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "ApiVersionSet_CreateOrUpdate", + "description": "Creates or Updates a Api Version Set.", + "x-ms-examples": { + "ApiManagementCreateApiVersionSet": { + "$ref": "./examples/ApiManagementCreateApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api Version Set was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Api Version Set was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiVersionSet" + ], + "operationId": "ApiVersionSet_Update", + "description": "Updates the details of the Api VersionSet specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateApiVersionSet": { + "$ref": "./examples/ApiManagementUpdateApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Version Set was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiVersionSets" + ], + "operationId": "ApiVersionSet_Delete", + "description": "Deletes specific Api Version Set.", + "x-ms-examples": { + "ApiManagementDeleteApiVersionSet": { + "$ref": "./examples/ApiManagementDeleteApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The ApiVersion Set details were successfully deleted." + }, + "204": { + "description": "The ApiVersion Set details were successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimauthorizationservers.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimauthorizationservers.json index 0ad2bbfb..124a78d7 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimauthorizationservers.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimauthorizationservers.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for managing OAuth2 servers configuration in your Azure API Management deployment. OAuth 2.0 can be used to authorize developer accounts for Azure API Management. For more information refer to [How to OAuth2](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-oauth2).", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers": { "get": { "tags": [ - "AuthorizationServers" + "AuthorizationServer" ], "operationId": "AuthorizationServer_ListByService", "description": "Lists a collection of authorization servers defined within a service instance.", @@ -58,7 +58,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -77,20 +77,26 @@ "200": { "description": "A Collection of the Authorization Server entities for the specified API Management service instance.", "schema": { - "$ref": "#/definitions/AuthorizationServerCollection" + "$ref": "./definitions.json#/definitions/AuthorizationServerCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/AuthorizationServerContract" + "x-ms-odata": "./definitions.json#/definitions/AuthorizationServerContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}": { "head": { "tags": [ - "AuthorizationServers" + "AuthorizationServer" ], "operationId": "AuthorizationServer_GetEntityTag", "description": "Gets the entity state (Etag) version of the authorizationServer specified by its identifier.", @@ -107,7 +113,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AuthenticationServerIdParameter" + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -136,7 +142,7 @@ }, "get": { "tags": [ - "AuthorizationServers" + "AuthorizationServer" ], "operationId": "AuthorizationServer_Get", "description": "Gets the details of the authorization server specified by its identifier.", @@ -153,7 +159,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AuthenticationServerIdParameter" + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -164,9 +170,9 @@ ], "responses": { "200": { - "description": "Gets the details of the specified authorization server.", + "description": "Gets the details of the specified authorization server. No secrets included.", "schema": { - "$ref": "#/definitions/AuthorizationServerContract" + "$ref": "./definitions.json#/definitions/AuthorizationServerContract" }, "headers": { "ETag": { @@ -185,7 +191,7 @@ }, "put": { "tags": [ - "AuthorizationServers" + "AuthorizationServer" ], "operationId": "AuthorizationServer_CreateOrUpdate", "description": "Creates new authorization server or updates an existing authorization server.", @@ -202,14 +208,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AuthenticationServerIdParameter" + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AuthorizationServerContract" + "$ref": "./definitions.json#/definitions/AuthorizationServerContract" }, "description": "Create or update parameters." }, @@ -226,14 +232,26 @@ "responses": { "201": { "description": "Authorization server was successfully registered.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/AuthorizationServerContract" + "$ref": "./definitions.json#/definitions/AuthorizationServerContract" } }, "200": { "description": "Authorization server is already registered.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/AuthorizationServerContract" + "$ref": "./definitions.json#/definitions/AuthorizationServerContract" } }, "default": { @@ -246,7 +264,7 @@ }, "patch": { "tags": [ - "AuthorizationServers" + "AuthorizationServer" ], "operationId": "AuthorizationServer_Update", "description": "Updates the details of the authorization server specified by its identifier.", @@ -263,14 +281,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AuthenticationServerIdParameter" + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AuthorizationServerUpdateContract" + "$ref": "./definitions.json#/definitions/AuthorizationServerUpdateContract" }, "description": "OAuth2 Server settings Update parameters." }, @@ -285,8 +303,17 @@ } ], "responses": { - "204": { - "description": "The authorization server settings were successfully updated." + "200": { + "description": "The authorization server settings were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationServerContract" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -298,7 +325,7 @@ }, "delete": { "tags": [ - "AuthorizationServers" + "AuthorizationServer" ], "operationId": "AuthorizationServer_Delete", "description": "Deletes specific authorization server instance.", @@ -315,7 +342,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/AuthenticationServerIdParameter" + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -342,341 +369,59 @@ } } } - } - }, - "definitions": { - "AuthorizationServerCollection": { - "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": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AuthorizationServerContractProperties", - "description": "Properties of the External OAuth authorization server Contract." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "External OAuth authorization server settings." - }, - "AuthorizationServerContractProperties": { - "properties": { - "displayName": { - "type": "string", - "description": "User-friendly authorization server name.", - "minLength": 1, - "maxLength": 50 - }, - "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" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}/listSecrets": { + "post": { + "tags": [ + "AuthorizationServer" + ], + "operationId": "AuthorizationServer_ListSecrets", + "description": "Gets the client secret details of the authorization server.", + "x-ms-examples": { + "ApiManagementAuthorizationServerListSecrets": { + "$ref": "./examples/ApiManagementAuthorizationServerListSecrets.json" } }, - "clientId": { - "type": "string", - "description": "Client or app id registered with this authorization server." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AuthorizationServerContractBaseProperties" - } - ], - "required": [ - "displayName", - "clientRegistrationEndpoint", - "authorizationEndpoint", - "clientId", - "grantTypes" - ], - "description": "External OAuth authorization server settings Properties." - }, - "AuthorizationServerUpdateContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AuthorizationServerUpdateContractProperties", - "description": "Properties of the External OAuth authorization server update Contract." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "External OAuth authorization server settings." - }, - "AuthorizationServerUpdateContractProperties": { - "properties": { - "displayName": { - "type": "string", - "description": "User-friendly authorization server name.", - "minLength": 1, - "maxLength": 50 - }, - "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." - } - ] - } + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" }, - "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." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AuthorizationServerContractBaseProperties" - } - ], - "description": "External OAuth authorization server Update settings contract." - }, - "AuthorizationServerContractBaseProperties": { - "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 - } + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, - "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." - } - ] - } + { + "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" }, - "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" + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, - "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" + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } - }, - "bearerTokenSendingMethods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "authorizationHeader", - "query" - ], - "x-ms-enum": { - "name": "BearerTokenSendingMethod", - "modelAsString": true + ], + "responses": { + "200": { + "description": "Gets the secrets of the specified authorization server.", + "schema": { + "$ref": "./definitions.json#/definitions/AuthorizationServerSecretsContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, - "description": "Specifies the mechanism by which access token is passed to the API. ", - "externalDocs": { - "url": "http://tools.ietf.org/html/rfc6749#section-4" + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } - }, - "clientSecret": { - "type": "string", - "description": "Client or app secret registered with this authorization server." - }, - "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." - }, - "TokenBodyParameterContract": { - "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)." + } } }, - "parameters": { - "AuthenticationServerIdParameter": { - "name": "authsid", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the authorization server.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimbackends.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimbackends.json index 10c59fd6..0a80e307 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimbackends.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimbackends.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on Backend entity in Azure API Management deployment. The Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends": { "get": { "tags": [ - "Backends" + "Backend" ], "operationId": "Backend_ListByService", "description": "Lists a collection of backends in the specified service instance.", @@ -58,7 +58,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| host | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -77,7 +77,7 @@ "200": { "description": "Lists a collection of Backend entities.", "schema": { - "$ref": "#/definitions/BackendCollection" + "$ref": "./definitions.json#/definitions/BackendCollection" } }, "default": { @@ -90,13 +90,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/BackendContract" + "x-ms-odata": "./definitions.json#/definitions/BackendContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}": { "head": { "tags": [ - "Backends" + "Backend" ], "operationId": "Backend_GetEntityTag", "description": "Gets the entity state (Etag) version of the backend specified by its identifier.", @@ -113,7 +113,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BackendIdParameter" + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -142,7 +142,7 @@ }, "get": { "tags": [ - "Backends" + "Backend" ], "operationId": "Backend_Get", "description": "Gets the details of the backend specified by its identifier.", @@ -159,7 +159,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BackendIdParameter" + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -172,7 +172,7 @@ "200": { "description": "The response body contains the specified Backend entity.", "schema": { - "$ref": "#/definitions/BackendContract" + "$ref": "./definitions.json#/definitions/BackendContract" }, "headers": { "ETag": { @@ -191,7 +191,7 @@ }, "put": { "tags": [ - "Backends" + "Backend" ], "operationId": "Backend_CreateOrUpdate", "description": "Creates or Updates a backend.", @@ -211,14 +211,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BackendIdParameter" + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/BackendContract" + "$ref": "./definitions.json#/definitions/BackendContract" }, "description": "Create parameters." }, @@ -235,14 +235,26 @@ "responses": { "201": { "description": "Backend was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/BackendContract" + "$ref": "./definitions.json#/definitions/BackendContract" } }, "200": { "description": "The existing backend was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/BackendContract" + "$ref": "./definitions.json#/definitions/BackendContract" } }, "default": { @@ -255,7 +267,7 @@ }, "patch": { "tags": [ - "Backends" + "Backend" ], "operationId": "Backend_Update", "description": "Updates an existing backend.", @@ -272,14 +284,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BackendIdParameter" + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/BackendUpdateParameters" + "$ref": "./definitions.json#/definitions/BackendUpdateParameters" }, "description": "Update parameters." }, @@ -294,8 +306,17 @@ } ], "responses": { - "204": { - "description": "The existing backend was successfully updated." + "200": { + "description": "The existing backend was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/BackendContract" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -307,15 +328,15 @@ }, "delete": { "tags": [ - "Backends" + "Backend" ], "operationId": "Backend_Delete", + "description": "Deletes the specified backend.", "x-ms-examples": { "ApiManagementDeleteBackend": { "$ref": "./examples/ApiManagementDeleteBackend.json" } }, - "description": "Deletes the specified backend.", "parameters": [ { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" @@ -324,7 +345,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BackendIdParameter" + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -352,10 +373,10 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}/reconnect": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}/reconnect": { "post": { "tags": [ - "Backends" + "BackendReconnect" ], "operationId": "Backend_Reconnect", "description": "Notifies the APIM proxy to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.", @@ -372,14 +393,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/BackendIdParameter" + "$ref": "./apimanagement.json#/parameters/BackendIdParameter" }, { "name": "parameters", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/BackendReconnectContract" + "$ref": "./definitions.json#/definitions/BackendReconnectContract" }, "description": "Reconnect request parameters." }, @@ -404,367 +425,6 @@ } } }, - "definitions": { - "BackendAuthorizationHeaderCredentials": { - "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": { - "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 Proxy Contract Properties" - }, - "tls": { - "$ref": "#/definitions/BackendTlsProperties", - "description": "Backend TLS Properties" - } - }, - "description": "Backend entity base Parameter set." - }, - "BackendCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/BackendContract" - }, - "description": "Backend values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Backend list representation." - }, - "BackendContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/BackendContractProperties", - "description": "Backend entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Backend details." - }, - "BackendContractProperties": { - "properties": { - "url": { - "type": "string", - "description": "Runtime Url of the Backend.", - "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." - } - }, - "allOf": [ - { - "$ref": "#/definitions/BackendBaseParameters" - } - ], - "required": [ - "url", - "protocol" - ], - "description": "Parameters supplied to the Create Backend operation." - }, - "BackendCredentialsContract": { - "properties": { - "certificate": { - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 32, - "description": "List of Client Certificate Thumbprint." - }, - "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": { - "properties": { - "serviceFabricCluster": { - "$ref": "#/definitions/BackendServiceFabricClusterProperties", - "description": "Backend Service Fabric Cluster Properties" - } - }, - "description": "Properties specific to the Backend Type." - }, - "BackendServiceFabricClusterProperties": { - "properties": { - "clientCertificatethumbprint": { - "description": "The client certificate thumbprint for the management endpoint.", - "type": "string" - }, - "maxPartitionResolutionRetries": { - "description": "Maximum number of retries while attempting resolve the parition.", - "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" - }, - "description": "Server X509 Certificate Names Collection" - } - }, - "required": [ - "managementEndpoints", - "clientCertificatethumbprint" - ], - "description": "Properties of the Service Fabric Type Backend." - }, - "X509CertificateName": { - "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." - }, - "BackendTlsProperties": { - "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." - }, - "BackendProxyContract": { - "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." - }, - "BackendUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/BackendUpdateParameterProperties", - "description": "Backend entity update contract properties." - } - }, - "description": "Backend update parameters." - }, - "BackendUpdateParameterProperties": { - "properties": { - "url": { - "type": "string", - "description": "Runtime Url of the Backend.", - "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." - } - }, - "allOf": [ - { - "$ref": "#/definitions/BackendBaseParameters" - } - ], - "description": "Parameters supplied to the Update Backend operation." - }, - "BackendReconnectContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/BackendReconnectProperties", - "description": "Reconnect request properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Reconnect request parameters." - }, - "BackendReconnectProperties": { - "properties": { - "after": { - "type": "string", - "format": "duration", - "description": "Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconect is PT2M." - } - }, - "description": "Properties to control reconnect requests." - } - }, - "parameters": { - "BackendIdParameter": { - "name": "backendid", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcaches.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcaches.json new file mode 100644 index 00000000..f552517f --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcaches.json @@ -0,0 +1,372 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Cache entity in your Azure API Management deployment. Azure API Management also allows for caching responses in an external Azure Cache for Redis. For more information refer to [External Redis Cache in ApiManagement](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external).", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches": { + "get": { + "tags": [ + "Cache" + ], + "operationId": "Cache_ListByService", + "description": "Lists a collection of all external Caches in the specified service instance.", + "x-ms-examples": { + "ApiManagementListCaches": { + "$ref": "./examples/ApiManagementListCaches.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns a collection of Cache entity.", + "schema": { + "$ref": "./definitions.json#/definitions/CacheCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}": { + "head": { + "tags": [ + "Cache" + ], + "operationId": "Cache_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Cache specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadCache": { + "$ref": "./examples/ApiManagementHeadCache.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CacheIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Cache entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Cache" + ], + "operationId": "Cache_Get", + "description": "Gets the details of the Cache specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetCache": { + "$ref": "./examples/ApiManagementGetCache.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CacheIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Cache entity.", + "schema": { + "$ref": "./definitions.json#/definitions/CacheContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Cache" + ], + "operationId": "Cache_CreateOrUpdate", + "description": "Creates or updates an External Cache to be used in Api Management instance.", + "externalDocs": { + "description": "Use an external cache in Azure API Management", + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external" + }, + "x-ms-examples": { + "ApiManagementCreateCache": { + "$ref": "./examples/ApiManagementCreateCache.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CacheIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/CacheContract" + }, + "description": "Create or Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new Cache was successfully added.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CacheContract" + } + }, + "200": { + "description": "The Cache details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CacheContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Cache" + ], + "operationId": "Cache_Update", + "description": "Updates the details of the cache specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateCache": { + "$ref": "./examples/ApiManagementUpdateCache.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CacheIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/CacheUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Cache details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CacheContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Cache" + ], + "operationId": "Cache_Delete", + "description": "Deletes specific Cache.", + "x-ms-examples": { + "ApiManagementDeleteCache": { + "$ref": "./examples/ApiManagementDeleteCache.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CacheIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Cache was successfully deleted." + }, + "204": { + "description": "The Cache was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcertificates.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcertificates.json index e895ee01..ff9e92de 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcertificates.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcertificates.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual authentication with your Backend in API Management. For more information refer to [How to secure backend using Mutual Auth Certificate](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates).", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates": { "get": { "tags": [ - "Certificates" + "Certificate" ], "operationId": "Certificate_ListByService", "description": "Lists a collection of all certificates in the specified service instance.", @@ -58,7 +58,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|----------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| subject | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| thumbprint | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| expirationDate | ge, le, eq, ne, gt, lt | N/A |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -66,6 +66,13 @@ { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, + { + "name": "isKeyVaultRefreshFailed", + "in": "query", + "required": false, + "type": "boolean", + "description": "When set to true, the response contains only certificates entities which failed refresh." + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -77,7 +84,7 @@ "200": { "description": "Returns a collection of Certificate entity.", "schema": { - "$ref": "#/definitions/CertificateCollection" + "$ref": "./definitions.json#/definitions/CertificateCollection" } }, "default": { @@ -90,13 +97,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/CertificateContract" + "x-ms-odata": "./definitions.json#/definitions/CertificateContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}": { "head": { "tags": [ - "Certificates" + "Certificate" ], "operationId": "Certificate_GetEntityTag", "description": "Gets the entity state (Etag) version of the certificate specified by its identifier.", @@ -113,7 +120,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/CertificateIdParameter" + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -142,13 +149,16 @@ }, "get": { "tags": [ - "Certificates" + "Certificate" ], "operationId": "Certificate_Get", "description": "Gets the details of the certificate specified by its identifier.", "x-ms-examples": { "ApiManagementGetCertificate": { "$ref": "./examples/ApiManagementGetCertificate.json" + }, + "ApiManagementGetCertificateWithKeyVault": { + "$ref": "./examples/ApiManagementGetCertificateWithKeyVault.json" } }, "parameters": [ @@ -159,7 +169,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/CertificateIdParameter" + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -172,7 +182,7 @@ "200": { "description": "The response body contains the specified Certificate entity.", "schema": { - "$ref": "#/definitions/CertificateContract" + "$ref": "./definitions.json#/definitions/CertificateContract" }, "headers": { "ETag": { @@ -191,7 +201,7 @@ }, "put": { "tags": [ - "Certificates" + "Certificate" ], "operationId": "Certificate_CreateOrUpdate", "description": "Creates or updates the certificate being used for authentication with the backend.", @@ -202,6 +212,9 @@ "x-ms-examples": { "ApiManagementCreateCertificate": { "$ref": "./examples/ApiManagementCreateCertificate.json" + }, + "ApiManagementCreateCertificateWithKeyVault": { + "$ref": "./examples/ApiManagementCreateCertificateWithKeyVault.json" } }, "parameters": [ @@ -212,14 +225,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/CertificateIdParameter" + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CertificateCreateOrUpdateParameters" + "$ref": "./definitions.json#/definitions/CertificateCreateOrUpdateParameters" }, "description": "Create or Update parameters." }, @@ -236,14 +249,26 @@ "responses": { "201": { "description": "The new certificate was successfully added.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/CertificateContract" + "$ref": "./definitions.json#/definitions/CertificateContract" } }, "200": { "description": "The certificate details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/CertificateContract" + "$ref": "./definitions.json#/definitions/CertificateContract" } }, "default": { @@ -256,7 +281,7 @@ }, "delete": { "tags": [ - "Certificates" + "Certificate" ], "operationId": "Certificate_Delete", "description": "Deletes specific certificate.", @@ -273,7 +298,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/CertificateIdParameter" + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -300,102 +325,63 @@ } } } - } - }, - "definitions": { - "CertificateCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/CertificateContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Certificates list representation." - }, - "CertificateContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/CertificateContractProperties", - "description": "Certificate properties details." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Certificate details." }, - "CertificateContractProperties": { - "properties": { - "subject": { - "type": "string", - "description": "Subject attribute of the certificate." - }, - "thumbprint": { - "type": "string", - "description": "Thumbprint of the certificate." + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}/refreshSecret": { + "post": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_RefreshSecret", + "description": "From KeyVault, Refresh the certificate being used for authentication with the backend.", + "externalDocs": { + "description": "How to secure back-end services using client certificate authentication in Azure API Management", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" }, - "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" - } - }, - "required": [ - "subject", - "thumbprint", - "expirationDate" - ], - "description": "Properties of the Certificate contract." - }, - "CertificateCreateOrUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/CertificateCreateOrUpdateProperties", - "description": "Certificate create or update properties details." - } - }, - "description": "Certificate create or update details." - }, - "CertificateCreateOrUpdateProperties": { - "properties": { - "data": { - "type": "string", - "description": "Base 64 encoded certificate using the application/x-pkcs12 representation." + "x-ms-examples": { + "ApiManagementRefreshCertificate": { + "$ref": "./examples/ApiManagementRefreshCertificate.json" + } }, - "password": { - "type": "string", - "description": "Password for the Certificate" + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The certificate details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/CertificateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } - }, - "required": [ - "data", - "password" - ], - "description": "Parameters supplied to the CreateOrUpdate certificate operation." + } } }, - "parameters": { - "CertificateIdParameter": { - "name": "certificateId", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimconnectivitycheck.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimconnectivitycheck.json new file mode 100644 index 00000000..e83fbef8 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimconnectivitycheck.json @@ -0,0 +1,99 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use this REST APIs to perform connectivity troubleshoot operations in API Management deployments.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/connectivityCheck": { + "post": { + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "tags": [ + "PerformConnectivityCheck" + ], + "operationId": "PerformConnectivityCheckAsync", + "description": "Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.", + "x-ms-examples": { + "TCP Connectivity Check": { + "$ref": "./examples/ApiManagementPerformConnectivityCheck.json" + }, + "HTTP Connectivity Check": { + "$ref": "./examples/ApiManagementPerformConnectivityCheckHttpConnect.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "connectivityCheckRequestParams", + "description": "Connectivity Check request parameters.", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/ConnectivityCheckRequest" + } + } + ], + "responses": { + "202": { + "description": "Request was accepted and is currently running. Location header contains the URL where the status of the long running operation can be checked and the result eventually retrieved." + }, + "200": { + "description": "Connectivity Check Request was completed.", + "schema": { + "$ref": "./definitions.json#/definitions/ConnectivityCheckResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + } + } +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcontenttypes.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcontenttypes.json new file mode 100644 index 00000000..97a6e93a --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcontenttypes.json @@ -0,0 +1,513 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes": { + "get": { + "tags": [ + "ContentType" + ], + "operationId": "ContentType_ListByService", + "description": "Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.", + "x-ms-examples": { + "ApiManagementListContentTypes": { + "$ref": "./examples/ApiManagementListContentTypes.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns a collection of the Content Type entities.", + "schema": { + "$ref": "./definitions.json#/definitions/ContentTypeCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}": { + "get": { + "tags": [ + "ContentType" + ], + "operationId": "ContentType_Get", + "description": "Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.", + "x-ms-examples": { + "ApiManagementGetContentType": { + "$ref": "./examples/ApiManagementGetContentType.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the details of the specified content type.", + "schema": { + "$ref": "./definitions.json#/definitions/ContentTypeContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ContentType" + ], + "operationId": "ContentType_CreateOrUpdate", + "description": "Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified.", + "x-ms-examples": { + "ApiManagementCreateContentType": { + "$ref": "./examples/ApiManagementCreateContentType.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The content type was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/ContentTypeContract" + } + }, + "200": { + "description": "The existing content type was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/ContentTypeContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ContentType" + ], + "operationId": "ContentType_Delete", + "description": "Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the `c-` prefix) can't be removed.", + "x-ms-examples": { + "ApiManagementDeleteContentType": { + "$ref": "./examples/ApiManagementDeleteContentType.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The content type was successfully deleted." + }, + "204": { + "description": "The content type was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems": { + "get": { + "tags": [ + "ContentTypeContentItem" + ], + "operationId": "ContentItem_ListByService", + "description": "Lists developer portal's content items specified by the provided content type.", + "x-ms-examples": { + "ApiManagementListContentTypeContentItems": { + "$ref": "./examples/ApiManagementListContentTypeContentItems.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns a collection of Content Type entities.", + "schema": { + "$ref": "./definitions.json#/definitions/ContentItemCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}": { + "head": { + "tags": [ + "ContentTypeContentItem" + ], + "operationId": "ContentItem_GetEntityTag", + "description": "Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadContentTypeContentItem": { + "$ref": "./examples/ApiManagementHeadContentTypeContentItem.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified content item entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ContentTypeContentItem" + ], + "operationId": "ContentItem_Get", + "description": "Returns the developer portal's content item specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetContentTypeContentItem": { + "$ref": "./examples/ApiManagementGetContentTypeContentItem.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the content item.", + "schema": { + "$ref": "./definitions.json#/definitions/ContentItemContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ContentTypeContentItem" + ], + "operationId": "ContentItem_CreateOrUpdate", + "description": "Creates a new developer portal's content item specified by the provided content type.", + "x-ms-examples": { + "ApiManagementCreateContentTypeContentItem": { + "$ref": "./examples/ApiManagementCreateContentTypeContentItem.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The content item was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/ContentItemContract" + } + }, + "200": { + "description": "The existing content item was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/ContentItemContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ContentTypeContentItem" + ], + "operationId": "ContentItem_Delete", + "description": "Removes the specified developer portal's content item.", + "x-ms-examples": { + "ApiManagementDeleteContentTypeContentItem": { + "$ref": "./examples/ApiManagementDeleteContentTypeContentItem.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The content item was successfully deleted." + }, + "204": { + "description": "The content item was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdeletedservices.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdeletedservices.json new file mode 100644 index 00000000..6b367b23 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdeletedservices.json @@ -0,0 +1,179 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/deletedservices": { + "get": { + "tags": [ + "DeletedService" + ], + "operationId": "DeletedServices_ListBySubscription", + "description": "Lists all soft-deleted services available for undelete for the given subscription.", + "x-ms-examples": { + "ApiManagementDeletedServicesListBySubscription": { + "$ref": "./examples/ApiManagementDeletedServicesListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of all soft-deleted services available for undelete for the given subscription.", + "schema": { + "$ref": "./definitions.json#/definitions/DeletedServicesCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/deletedservices/{serviceName}": { + "get": { + "tags": [ + "DeletedService" + ], + "operationId": "DeletedServices_GetByName", + "description": "Get soft-deleted Api Management Service by name.", + "x-ms-examples": { + "ApiManagementGetDeletedServiceByName": { + "$ref": "./examples/ApiManagementGetDeletedServiceByName.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the deleted API Management service." + } + ], + "responses": { + "200": { + "description": "Soft-deleted Api Management Service.", + "schema": { + "$ref": "./definitions.json#/definitions/DeletedServiceContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DeletedService" + ], + "operationId": "DeletedServices_Purge", + "description": "Purges Api Management Service (deletes it with no option to undelete).", + "x-ms-examples": { + "ApiManagementDeletedServicesPurge": { + "$ref": "./examples/ApiManagementDeletedServicesPurge.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the deleted API Management service." + } + ], + "responses": { + "200": { + "description": "Api Service was successfully purged." + }, + "202": { + "description": "Api Service purge started.", + "schema": { + "$ref": "./definitions.json#/definitions/DeletedServiceContract" + } + }, + "204": { + "description": "The service does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdeployment.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdeployment.json index 11a7554f..0805e121 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdeployment.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdeployment.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs to manage Azure API Management deployment.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -57,6 +57,61 @@ "schema": { "$ref": "#/definitions/OperationListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus": { + "get": { + "tags": [ + "ApiManagementServiceSkus" + ], + "summary": "Gets available SKUs for API Management service", + "description": "Gets all available SKU for a given API Management service", + "operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus", + "x-ms-examples": { + "ApiManagementListSKUs-Dedicated": { + "$ref": "./examples/ApiManagementListSKUs-Dedicated.json" + }, + "ApiManagementListSKUs-Consumption": { + "$ref": "./examples/ApiManagementListSKUs-Consumption.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SKUs.", + "schema": { + "$ref": "#/definitions/ResourceSkuResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -73,7 +128,7 @@ "description": "Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.", "x-ms-examples": { "ApiManagementRestoreService": { - "$ref": "./examples/ApiManagementRestoreService.json" + "$ref": "./examples/ApiManagementRestoreWithAccessKey.json" } }, "parameters": [ @@ -108,9 +163,18 @@ }, "202": { "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup": { @@ -121,8 +185,14 @@ "operationId": "ApiManagementService_Backup", "description": "Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.", "x-ms-examples": { - "ApiManagementCreateBackup": { - "$ref": "./examples/ApiManagementCreateBackup.json" + "ApiManagementBackupWithAccessKey": { + "$ref": "./examples/ApiManagementBackupWithAccessKey.json" + }, + "ApiManagementBackupWithSystemManagedIdentity": { + "$ref": "./examples/ApiManagementBackupWithSystemManagedIdentity.json" + }, + "ApiManagementBackupWithUserAssignedManagedIdentity": { + "$ref": "./examples/ApiManagementBackupWithUserAssignedManagedIdentity.json" } }, "parameters": [ @@ -157,9 +227,18 @@ }, "202": { "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}": { @@ -173,6 +252,9 @@ "ApiManagementCreateService": { "$ref": "./examples/ApiManagementCreateService.json" }, + "ApiManagementCreateServiceInVnetWithPublicIP": { + "$ref": "./examples/ApiManagementCreateServiceInVnetWithPublicIP.json" + }, "ApiManagementCreateMultiRegionServiceWithCustomHostname": { "$ref": "./examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json" }, @@ -181,6 +263,18 @@ }, "ApiManagementCreateServiceWithSystemCertificates": { "$ref": "./examples/ApiManagementCreateServiceWithSystemCertificates.json" + }, + "ApiManagementCreateServiceWithUserAssignedIdentity": { + "$ref": "./examples/ApiManagementCreateServiceWithUserAssignedIdentity.json" + }, + "ApiManagementCreateServiceInZones": { + "$ref": "./examples/ApiManagementCreateServiceInZones.json" + }, + "ApiManagementUndelete": { + "$ref": "./examples/ApiManagementUndelete.json" + }, + "ApiManagementCreateServiceWithCustomHostnameKeyVault": { + "$ref": "./examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json" } }, "parameters": [ @@ -220,9 +314,12 @@ } }, "202": { - "description": "Accepted the configuration change when updating the service.", + "description": "Accepted the configuration change when updating the service." + }, + "default": { + "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, @@ -240,6 +337,9 @@ }, "ApiManagementUpdateServicePublisherDetails": { "$ref": "./examples/ApiManagementUpdateServicePublisherDetails.json" + }, + "ApiManagementUpdateServiceToNewVnetAndAvailabilityZones": { + "$ref": "./examples/ApiManagementUpdateServiceToNewVnetAndAZs.json" } }, "parameters": [ @@ -274,6 +374,12 @@ }, "202": { "description": "The service update request was Accepted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } }, "x-ms-long-running-operation": true @@ -315,6 +421,12 @@ "schema": { "$ref": "#/definitions/ApiManagementServiceResource" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } } }, @@ -347,10 +459,23 @@ "200": { "description": "Service was successfully deleted." }, + "202": { + "description": "The service delete request was Accepted.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, "204": { - "description": "Service is already deleted." + "description": "The service does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } - } + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service": { @@ -382,6 +507,12 @@ "schema": { "$ref": "#/definitions/ApiManagementServiceListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -415,6 +546,12 @@ "schema": { "$ref": "#/definitions/ApiManagementServiceListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } }, "x-ms-pageable": { @@ -455,6 +592,12 @@ "x-ms-client-flatten": true, "$ref": "#/definitions/ApiManagementServiceGetSsoTokenResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } } } @@ -494,38 +637,29 @@ "schema": { "$ref": "#/definitions/ApiManagementServiceNameAvailabilityResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/getDomainOwnershipIdentifier": { "post": { "tags": [ "ApiManagementService" ], - "operationId": "ApiManagementService_ApplyNetworkConfigurationUpdates", - "description": "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings.", + "operationId": "ApiManagementService_GetDomainOwnershipIdentifier", + "description": "Get the custom domain ownership identifier for an API Management service.", "x-ms-examples": { - "ApiManagementApplyNetworkConfigurationUpdates": { - "$ref": "./examples/ApiManagementApplyNetworkConfigurationUpdates.json" + "ApiManagementServiceGetDomainOwnershipIdentifier": { + "$ref": "./examples/ApiManagementServiceGetDomainOwnershipIdentifier.json" } }, "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ApiManagementServiceApplyNetworkConfigurationParameters" - }, - "description": "Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region." - }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -534,74 +668,31 @@ } ], "responses": { - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, "200": { - "description": "Network configuration updates were successfully applied on the Api Management service.", + "description": "The result of getting domain ownership identifier.", "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" + "$ref": "#/definitions/ApiManagementServiceGetDomainOwnershipIdentifierResult" } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatecertificate": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_UploadCertificate", - "description": "Upload Custom Domain SSL certificate for an API Management service. This operation will be deprecated in future releases.", - "x-ms-examples": { - "ApiManagementServiceUploadProxyCertificate": { - "$ref": "./examples/ApiManagementServiceUploadProxyCertificate.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceUploadCertificateParameters" - }, - "description": "Parameters supplied to the Upload SSL certificate for an API Management service operation." - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully uploaded certificate to the API Management Service.", + "default": { + "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/CertificateInformation" + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatehostname": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates": { "post": { "tags": [ "ApiManagementService" ], - "operationId": "ApiManagementService_UpdateHostname", - "description": "Creates, updates, or deletes the custom hostnames for an API Management service. The custom hostname can be applied to the Proxy and Portal endpoint. This is a long running operation and could take several minutes to complete. This operation will be deprecated in the next version update.", + "operationId": "ApiManagementService_ApplyNetworkConfigurationUpdates", + "description": "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.", "x-ms-examples": { - "ApiManagementServiceUpdateHostName": { - "$ref": "./examples/ApiManagementServiceUpdateHostName.json" + "ApiManagementApplyNetworkConfigurationUpdates": { + "$ref": "./examples/ApiManagementApplyNetworkConfigurationUpdates.json" } }, "parameters": [ @@ -614,11 +705,11 @@ { "name": "parameters", "in": "body", - "required": true, + "required": false, "schema": { - "$ref": "#/definitions/ApiManagementServiceUpdateHostnameParameters" + "$ref": "#/definitions/ApiManagementServiceApplyNetworkConfigurationParameters" }, - "description": "Parameters supplied to the UpdateHostname operation." + "description": "Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region." }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -629,23 +720,173 @@ ], "responses": { "200": { - "description": "Service was successfully updated with desired hostnames.", + "description": "Network configuration updates were successfully applied on the Api Management service.", "schema": { "$ref": "#/definitions/ApiManagementServiceResource" } }, "202": { - "description": "Accepted. The location header contains the URL where the status of the long running operation can be checked. The response also includes the unmodified ApiManagementServiceResource.", + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "default": { + "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } } } }, "definitions": { + "ResourceSkuResults": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuResult" + }, + "x-ms-identifiers": [ + "resourceType", + "sku/name" + ], + "description": "The list of skus available for the service." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of API Management service Skus." + } + }, + "required": [ + "value" + ], + "description": "The API Management service SKUs operation response." + }, + "ResourceSkuResult": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "readOnly": true, + "description": "Specifies API Management SKU." + }, + "capacity": { + "$ref": "#/definitions/ResourceSkuCapacity", + "readOnly": true, + "description": "Specifies the number of API Management units." + } + }, + "description": "Describes an available API Management service SKU." + }, + "ResourceSkuCapacity": { + "properties": { + "minimum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The maximum capacity that can be set." + }, + "default": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The default capacity." + }, + "scaleType": { + "type": "string", + "readOnly": true, + "description": "The scale type applicable to the sku.", + "enum": [ + "automatic", + "manual", + "none" + ], + "x-ms-enum": { + "name": "ResourceSkuCapacityScaleType", + "modelAsString": true, + "values": [ + { + "value": "automatic", + "description": "Supported scale type automatic." + }, + { + "value": "manual", + "description": "Supported scale type manual." + }, + { + "value": "none", + "description": "Scaling not supported." + } + ] + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ResourceSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Sku.", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" + }, + "enum": [ + "Developer", + "Standard", + "Premium", + "Basic", + "Consumption", + "Isolated" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true, + "values": [ + { + "value": "Developer", + "description": "Developer SKU of Api Management." + }, + { + "value": "Standard", + "description": "Standard SKU of Api Management." + }, + { + "value": "Premium", + "description": "Premium SKU of Api Management." + }, + { + "value": "Basic", + "description": "Basic SKU of Api Management." + }, + { + "value": "Consumption", + "description": "Consumption SKU of Api Management." + }, + { + "value": "Isolated", + "description": "Isolated SKU of Api Management." + } + ] + } + } + }, + "description": "Describes an available API Management SKU." + }, "CertificateInformation": { "properties": { "expiry": { @@ -680,7 +921,7 @@ "description": "Certificate Password." }, "storeName": { - "description": "The System.Security.Cryptography.x509certificates.Storename certificate store location. Only Root and CertificateAuthority are valid locations.", + "description": "The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.", "type": "string", "enum": [ "CertificateAuthority", @@ -689,8 +930,7 @@ }, "certificate": { "$ref": "#/definitions/CertificateInformation", - "description": "Certificate information.", - "readOnly": true + "description": "Certificate information." } }, "required": [ @@ -707,11 +947,12 @@ "Proxy", "Portal", "Management", - "Scm" + "Scm", + "DeveloperPortal" ], "x-ms-enum": { "name": "HostnameType", - "modelAsString": false + "modelAsString": true } }, "hostName": { @@ -720,7 +961,11 @@ }, "keyVaultId": { "type": "string", - "description": "Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type *application/x-pkcs12*" + "description": "Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type *application/x-pkcs12*" + }, + "identityClientId": { + "type": "string", + "description": "System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate." }, "encodedCertificate": { "type": "string", @@ -742,8 +987,34 @@ }, "certificate": { "$ref": "#/definitions/CertificateInformation", - "description": "Certificate information.", - "readOnly": true + "description": "Certificate information." + }, + "certificateSource": { + "type": "string", + "description": "Certificate Source.", + "enum": [ + "Managed", + "KeyVault", + "Custom", + "BuiltIn" + ], + "x-ms-enum": { + "name": "CertificateSource", + "modelAsString": true + } + }, + "certificateStatus": { + "type": "string", + "description": "Certificate Status.", + "enum": [ + "Completed", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "CertificateStatus", + "modelAsString": true + } } }, "required": [ @@ -782,13 +1053,20 @@ "$ref": "#/definitions/ApiManagementServiceSkuProperties", "description": "SKU properties of the API Management service." }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, "publicIPAddresses": { "type": "array", "items": { "type": "string" }, "readOnly": true, - "description": "Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU." + "description": "Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU." }, "privateIPAddresses": { "type": "array", @@ -796,7 +1074,11 @@ "type": "string" }, "readOnly": true, - "description": "Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard and Premium SKU." + "description": "Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU." + }, + "publicIpAddressId": { + "type": "string", + "description": "Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network." }, "virtualNetworkConfiguration": { "$ref": "#/definitions/VirtualNetworkConfiguration", @@ -806,6 +1088,44 @@ "type": "string", "description": "Gateway URL of the API Management service in the Region.", "readOnly": true + }, + "disableGateway": { + "type": "boolean", + "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.", + "default": false + }, + "platformVersion": { + "type": "string", + "description": "Compute Platform Version running the service.", + "readOnly": true, + "enum": [ + "undetermined", + "stv1", + "stv2", + "mtv1" + ], + "x-ms-enum": { + "name": "PlatformVersion", + "modelAsString": true, + "values": [ + { + "value": "undetermined", + "description": "Platform version cannot be determined, as compute platform is not deployed." + }, + { + "value": "stv1", + "description": "Platform running the service on Single Tenant V1 platform." + }, + { + "value": "stv2", + "description": "Platform running the service on Single Tenant V2 platform." + }, + { + "value": "mtv1", + "description": "Platform running the service on Multi Tenant V1 platform." + } + ] + } } }, "required": [ @@ -818,24 +1138,55 @@ "properties": { "storageAccount": { "type": "string", - "description": "Azure Cloud Storage account (used to place/retrieve the backup) name." - }, - "accessKey": { - "type": "string", - "description": "Azure Cloud Storage account (used to place/retrieve the backup) access key." + "description": "The name of the Azure storage account (used to place/retrieve the backup)." }, "containerName": { "type": "string", - "description": "Azure Cloud Storage blob container name used to place/retrieve the backup." + "description": "The name of the blob container (used to place/retrieve the backup)." }, "backupName": { "type": "string", - "description": "The name of the backup file to create." + "description": "The name of the backup file to create/retrieve." + }, + "accessType": { + "type": "string", + "description": "The type of access to be used for the storage account.", + "default": "AccessKey", + "enum": [ + "AccessKey", + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "x-ms-enum": { + "name": "AccessType", + "modelAsString": true, + "values": [ + { + "value": "AccessKey", + "description": "Use access key." + }, + { + "value": "SystemAssignedManagedIdentity", + "description": "Use system assigned managed identity." + }, + { + "value": "UserAssignedManagedIdentity", + "description": "Use user assigned managed identity." + } + ] + } + }, + "accessKey": { + "type": "string", + "description": "Storage account access key. Required only if `accessType` is set to `AccessKey`." + }, + "clientId": { + "type": "string", + "description": "The Client ID of user assigned managed identity. Required only if `accessType` is set to `UserAssignedManagedIdentity`." } }, "required": [ "storageAccount", - "accessKey", "containerName", "backupName" ], @@ -933,11 +1284,20 @@ "description": "SCM endpoint URL of the API Management service.", "readOnly": true }, + "developerPortalUrl": { + "type": "string", + "description": "DEveloper Portal endpoint URL of the API Management service.", + "readOnly": true + }, "hostnameConfigurations": { "type": "array", "items": { "$ref": "#/definitions/HostnameConfiguration" }, + "x-ms-identifiers": [ + "hostName", + "type" + ], "description": "Custom hostname configuration of the API Management service." }, "publicIPAddresses": { @@ -946,7 +1306,7 @@ "type": "string" }, "readOnly": true, - "description": "Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU." + "description": "Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU." }, "privateIPAddresses": { "type": "array", @@ -954,7 +1314,23 @@ "type": "string" }, "readOnly": true, - "description": "Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU." + "description": "Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU." + }, + "publicIpAddressId": { + "type": "string", + "description": "Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network." + }, + "publicNetworkAccess": { + "description": "Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } }, "virtualNetworkConfiguration": { "$ref": "#/definitions/VirtualNetworkConfiguration", @@ -965,6 +1341,10 @@ "items": { "$ref": "#/definitions/AdditionalLocation" }, + "x-ms-identifiers": [ + "location", + "sku" + ], "description": "Additional datacenter locations of the API Management service." }, "customProperties": { @@ -972,18 +1352,31 @@ "additionalProperties": { "type": "string" }, - "description": "Custom properties of the API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1 and setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service." + "description": "Custom properties of the API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.
Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is `True` if the service was created on or before April 1st 2018 and `False` otherwise. Http2 setting's default value is `False`.

You can disable any of next ciphers by using settings `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. The default value is `true` for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384" }, "certificates": { "type": "array", "items": { "$ref": "#/definitions/CertificateConfiguration" }, + "x-ms-identifiers": [ + "certificate/thumbprint" + ], "description": "List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10." }, + "enableClientCertificate": { + "type": "boolean", + "description": "Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.", + "default": false + }, + "disableGateway": { + "type": "boolean", + "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.", + "default": false + }, "virtualNetworkType": { "type": "string", - "description": "The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", + "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", "default": "None", "enum": [ "None", @@ -1008,10 +1401,69 @@ } ] } + }, + "apiVersionConstraint": { + "$ref": "#/definitions/ApiVersionConstraint", + "description": "Control Plane Apis version constraint for the API Management service." + }, + "restore": { + "type": "boolean", + "description": "Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.", + "default": false + }, + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "./definitions.json#/definitions/RemotePrivateEndpointConnectionWrapper" + }, + "description": "List of Private Endpoint Connections of this service." + }, + "platformVersion": { + "type": "string", + "description": "Compute Platform Version running the service in this location.", + "readOnly": true, + "enum": [ + "undetermined", + "stv1", + "stv2", + "mtv1" + ], + "x-ms-enum": { + "name": "PlatformVersion", + "modelAsString": true, + "values": [ + { + "value": "undetermined", + "description": "Platform version cannot be determined, as compute platform is not deployed." + }, + { + "value": "stv1", + "description": "Platform running the service on Single Tenant V1 platform." + }, + { + "value": "stv2", + "description": "Platform running the service on Single Tenant V2 platform." + }, + { + "value": "mtv1", + "description": "Platform running the service on Multi Tenant V1 platform." + } + ] + } } }, "description": "Base Properties of an API Management service resource description." }, + "ApiVersionConstraint": { + "properties": { + "minApiVersion": { + "type": "string", + "description": "Limit control plane API calls to API Management service with version equal to or newer than this value.", + "example": "2019-01-01" + } + }, + "description": "Control Plane Apis version constraint for the API Management service." + }, "ApiManagementServiceSkuProperties": { "properties": { "name": { @@ -1024,7 +1476,9 @@ "Developer", "Standard", "Premium", - "Basic" + "Basic", + "Consumption", + "Isolated" ], "x-ms-enum": { "name": "SkuType", @@ -1045,6 +1499,14 @@ { "value": "Basic", "description": "Basic SKU of Api Management." + }, + { + "value": "Consumption", + "description": "Consumption SKU of Api Management." + }, + { + "value": "Isolated", + "description": "Isolated SKU of Api Management." } ] } @@ -1052,12 +1514,12 @@ "capacity": { "type": "integer", "format": "int32", - "description": "Capacity of the SKU (number of deployed units of the SKU). The default value is 1.", - "default": 1 + "description": "Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0." } }, "required": [ - "name" + "name", + "capacity" ], "description": "API Management service resource SKU properties." }, @@ -1076,6 +1538,11 @@ "$ref": "#/definitions/ApiManagementServiceIdentity", "description": "Managed service identity of the Api Management service." }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + }, "location": { "type": "string", "description": "Resource location.", @@ -1088,6 +1555,13 @@ "type": "string", "description": "ETag of the resource.", "readOnly": true + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." } }, "allOf": [ @@ -1149,6 +1623,13 @@ "type": "string", "description": "ETag of the resource.", "readOnly": true + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." } }, "allOf": [ @@ -1226,55 +1707,36 @@ }, "description": "Response of the CheckNameAvailability operation." }, - "ApiManagementServiceApplyNetworkConfigurationParameters": { + "ApiManagementServiceGetDomainOwnershipIdentifierResult": { "properties": { - "location": { + "domainOwnershipIdentifier": { "type": "string", - "description": "Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required." + "description": "The domain ownership identifier value.", + "readOnly": true } }, - "description": "Parameter supplied to the Apply Network configuration operation." + "description": "Response of the GetDomainOwnershipIdentifier operation." }, - "ApiManagementServiceUploadCertificateParameters": { + "ApiManagementServiceApplyNetworkConfigurationParameters": { "properties": { - "type": { - "type": "string", - "description": "Hostname type.", - "enum": [ - "Proxy", - "Portal", - "Management", - "Scm" - ], - "x-ms-enum": { - "name": "HostnameType", - "modelAsString": false - } - }, - "certificate": { - "type": "string", - "description": "Base64 Encoded certificate." - }, - "certificate_password": { + "location": { "type": "string", - "description": "Certificate password." + "description": "Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required." } }, - "required": [ - "type", - "certificate", - "certificate_password" - ], - "description": "Parameters supplied to the Upload SSL certificate for an API Management service operation." + "description": "Parameter supplied to the Apply Network configuration operation." }, "ApiManagementServiceIdentity": { "description": "Identity properties of the Api Management service resource.", "properties": { "type": { "type": "string", - "description": "The identity type. Currently the only supported type is 'SystemAssigned'.", + "description": "The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.", "enum": [ - "SystemAssigned" + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" ], "x-ms-enum": { "name": "ApimIdentityType", @@ -1292,72 +1754,31 @@ "format": "uuid", "readOnly": true, "description": "The client tenant id of the identity." + }, + "userAssignedIdentities": { + "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } } }, "required": [ "type" ] }, - "HostnameConfigurationOld": { - "properties": { - "type": { - "type": "string", - "description": "Hostname type.", - "enum": [ - "Proxy", - "Portal", - "Management", - "Scm" - ], - "x-ms-enum": { - "name": "HostnameType", - "modelAsString": false - } - }, - "hostname": { - "type": "string", - "description": "Hostname to configure." - }, - "certificate": { - "$ref": "#/definitions/CertificateInformation", - "description": "Certificate information." - } - }, - "required": [ - "type", - "hostname", - "certificate" - ], - "description": "Custom hostname configuration." - }, - "ApiManagementServiceUpdateHostnameParameters": { + "UserIdentityProperties": { + "type": "object", "properties": { - "update": { - "type": "array", - "items": { - "$ref": "#/definitions/HostnameConfigurationOld" - }, - "description": "Hostnames to create or update." + "principalId": { + "description": "The principal id of user assigned identity.", + "type": "string" }, - "delete": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Proxy", - "Portal", - "Management", - "Scm" - ], - "x-ms-enum": { - "name": "HostnameType", - "modelAsString": false - } - }, - "description": "Hostnames types to delete." + "clientId": { + "description": "The client id of user assigned identity.", + "type": "string" } - }, - "description": "Parameters supplied to the UpdateHostname operation." + } }, "Operation": { "description": "REST API operation", @@ -1407,6 +1828,9 @@ "items": { "$ref": "#/definitions/Operation" }, + "x-ms-identifiers": [ + "name" + ], "description": "List of operations supported by the resource provider." }, "nextLink": { @@ -1417,4 +1841,4 @@ } }, "parameters": {} -} \ No newline at end of file +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdiagnostics.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdiagnostics.json index e1c5eb28..0226b0a0 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdiagnostics.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimdiagnostics.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on Diagnostic entity associated with your Azure API Management deployment. Diagnostics are used to log requests/responses in the APIM proxy.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics": { "get": { "tags": [ - "Diagnostics" + "Diagnostic" ], "operationId": "Diagnostic_ListByService", "description": "Lists all diagnostics of the API Management service instance.", @@ -53,31 +53,31 @@ { "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" }, { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "Paged Result reponse of diagnostics.", + "description": "Paged Result response of diagnostics.", "schema": { - "$ref": "#/definitions/DiagnosticCollection" + "$ref": "./definitions.json#/definitions/DiagnosticCollection" } }, "default": { @@ -90,13 +90,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/DiagnosticContract" + "x-ms-odata": "./definitions.json#/definitions/DiagnosticContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}": { "head": { "tags": [ - "Diagnostics" + "Diagnostic" ], "operationId": "Diagnostic_GetEntityTag", "description": "Gets the entity state (Etag) version of the Diagnostic specified by its identifier.", @@ -113,7 +113,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -124,7 +124,7 @@ ], "responses": { "200": { - "description": "Operation completed successfully.", + "description": "Gets the entity tag of the diagnostic", "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", @@ -142,7 +142,7 @@ }, "get": { "tags": [ - "Diagnostics" + "Diagnostic" ], "operationId": "Diagnostic_Get", "description": "Gets the details of the Diagnostic specified by its identifier.", @@ -159,7 +159,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -171,14 +171,14 @@ "responses": { "200": { "description": "The response body contains the specified Diagnostic entity.", - "schema": { - "$ref": "#/definitions/DiagnosticContract" - }, "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", "type": "string" } + }, + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" } }, "default": { @@ -191,7 +191,7 @@ }, "put": { "tags": [ - "Diagnostics" + "Diagnostic" ], "operationId": "Diagnostic_CreateOrUpdate", "description": "Creates a new Diagnostic or updates an existing one.", @@ -208,14 +208,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/DiagnosticContract" + "$ref": "./definitions.json#/definitions/DiagnosticContract" }, "description": "Create parameters." }, @@ -232,14 +232,26 @@ "responses": { "201": { "description": "Diagnostic was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/DiagnosticContract" + "$ref": "./definitions.json#/definitions/DiagnosticContract" } }, "200": { - "description": "Diagnostic was successfully updated.", + "description": "Diagnostic successfully updated", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/DiagnosticContract" + "$ref": "./definitions.json#/definitions/DiagnosticContract" } }, "default": { @@ -252,7 +264,7 @@ }, "patch": { "tags": [ - "Diagnostics" + "Diagnostic" ], "operationId": "Diagnostic_Update", "description": "Updates the details of the Diagnostic specified by its identifier.", @@ -269,14 +281,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/DiagnosticContract" + "$ref": "./definitions.json#/definitions/DiagnosticContract" }, "description": "Diagnostic Update parameters." }, @@ -291,8 +303,17 @@ } ], "responses": { - "204": { - "description": "The Diagnostic was successfully updated." + "200": { + "description": "Diagnostic successfully updated", + "schema": { + "$ref": "./definitions.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -304,7 +325,7 @@ }, "delete": { "tags": [ - "Diagnostics" + "Diagnostic" ], "operationId": "Diagnostic_Delete", "description": "Deletes the specified Diagnostic.", @@ -321,7 +342,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/DiagnosticIdParameter" + "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -348,272 +369,8 @@ } } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}/loggers": { - "get": { - "tags": [ - "DiagnosticLoggers" - ], - "operationId": "DiagnosticLogger_ListByService", - "description": "Lists all loggers assosiated with the specified Diagnostic of the API Management service instance.", - "x-ms-examples": { - "ApiManagementListDiagnosticLoggers": { - "$ref": "./examples/ApiManagementListDiagnosticLoggers.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/DiagnosticIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| type | eq | |" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result reponse of loggers assigned to the specified Diagnostic.", - "schema": { - "$ref": "./apimloggers.json#/definitions/LoggerCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "./apimloggers.json#/definitions/LoggerContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}/loggers/{loggerid}": { - "head": { - "tags": [ - "DiagnosticLoggers" - ], - "operationId": "DiagnosticLogger_CheckEntityExists", - "description": "Checks that logger entity specified by identifier is associated with the diagnostics entity.", - "x-ms-examples": { - "ApiManagementHeadDiagnosticLogger": { - "$ref": "./examples/ApiManagementHeadDiagnosticLogger.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "./apimloggers.json#/parameters/LoggerIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "The logger is associated with the diagnostic entity." - }, - "404": { - "description": "The logger is not associated with the diagnostic entity." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "DiagnosticLoggers" - ], - "operationId": "DiagnosticLogger_CreateOrUpdate", - "description": "Attaches a logger to a dignostic.", - "x-ms-examples": { - "ApiManagementCreateDiagnosticLogger": { - "$ref": "./examples/ApiManagementCreateDiagnosticLogger.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "./apimloggers.json#/parameters/LoggerIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Logger was successfully attached to Diagnostic.", - "schema": { - "$ref": "./apimloggers.json#/definitions/LoggerContract" - } - }, - "200": { - "description": "Logger to Diagnostic link was successfully updated.", - "schema": { - "$ref": "./apimloggers.json#/definitions/LoggerContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "DiagnosticLoggers" - ], - "operationId": "DiagnosticLogger_Delete", - "description": "Deletes the specified Logger from Diagnostic.", - "x-ms-examples": { - "ApiManagementDeleteDiagnosticLogger": { - "$ref": "./examples/ApiManagementDeleteDiagnosticLogger.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "./apimloggers.json#/parameters/LoggerIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Logger was successfully detached from Diagnostic." - }, - "204": { - "description": "The Logger was successfully detached from Diagnostic." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - } } }, - "definitions": { - "DiagnosticCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnosticContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Diagnostic list representation." - }, - "DiagnosticContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DiagnosticContractProperties", - "description": "Diagnostic entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Diagnostic details." - }, - "DiagnosticContractProperties": { - "properties": { - "enabled": { - "type": "boolean", - "description": "Indicates whether a diagnostic should receive data or not." - } - }, - "required": [ - "enabled" - ], - "description": "Diagnostic Entity Properties" - } - }, - "parameters": { - "DiagnosticIdParameter": { - "name": "diagnosticId", - "in": "path", - "required": true, - "type": "string", - "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimemailtemplates.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimemailtemplates.json new file mode 100644 index 00000000..d8cf5a7f --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimemailtemplates.json @@ -0,0 +1,363 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Email Templates associated with your Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates": { + "get": { + "tags": [ + "EmailTemplate" + ], + "operationId": "EmailTemplate_ListByService", + "description": "Gets all email templates", + "x-ms-examples": { + "ApiManagementListTemplates": { + "$ref": "./examples/ApiManagementListTemplates.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Email Template for the specified API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}": { + "head": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_GetEntityTag", + "description": "Gets the entity state (Etag) version of the email template specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadEmailTemplate": { + "$ref": "./examples/ApiManagementHeadEmailTemplate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified email template entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_Get", + "description": "Gets the details of the email template specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetTemplate": { + "$ref": "./examples/ApiManagementGetTemplate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Email template.", + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_CreateOrUpdate", + "description": "Updates an Email Template.", + "x-ms-examples": { + "ApiManagementCreateTemplate": { + "$ref": "./examples/ApiManagementCreateTemplate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateUpdateParameters" + }, + "description": "Email Template update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Email Template was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateContract" + } + }, + "200": { + "description": "Email Template was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_Update", + "description": "Updates API Management email template", + "x-ms-examples": { + "ApiManagementUpdateTemplate": { + "$ref": "./examples/ApiManagementUpdateTemplate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "email template successfully updated", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/EmailTemplateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_Delete", + "description": "Reset the Email Template to default template provided by the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteTemplate": { + "$ref": "./examples/ApiManagementDeleteTemplate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Email Template was successfully reset to default." + }, + "204": { + "description": "Email Template was successfully reset to default." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimgateways.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimgateways.json new file mode 100644 index 00000000..56dc3e2e --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimgateways.json @@ -0,0 +1,1325 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Gateway entity in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways": { + "get": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_ListByService", + "description": "Lists a collection of gateways registered with service instance.", + "x-ms-examples": { + "ApiManagementListGateways": { + "$ref": "./examples/ApiManagementListGateways.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Gateway entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/GatewayContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}": { + "head": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Gateway specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadGateway": { + "$ref": "./examples/ApiManagementHeadGateway.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Gateway entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_Get", + "description": "Gets the details of the Gateway specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetGateway": { + "$ref": "./examples/ApiManagementGetGateway.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Gateway entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_CreateOrUpdate", + "description": "Creates or updates a Gateway to be used in Api Management instance.", + "x-ms-examples": { + "ApiManagementCreateGateway": { + "$ref": "./examples/ApiManagementCreateGateway.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new Gateway was successfully added.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + } + }, + "200": { + "description": "The Gateway details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_Update", + "description": "Updates the details of the gateway specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateGateway": { + "$ref": "./examples/ApiManagementUpdateGateway.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Gateway details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Gateway" + ], + "operationId": "Gateway_Delete", + "description": "Deletes specific Gateway.", + "x-ms-examples": { + "ApiManagementDeleteGateway": { + "$ref": "./examples/ApiManagementDeleteGateway.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Gateway was successfully deleted." + }, + "204": { + "description": "The Gateway was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys": { + "post": { + "tags": [ + "GatewayListKeys" + ], + "operationId": "Gateway_ListKeys", + "description": "Retrieves gateway keys.", + "x-ms-examples": { + "ApiManagementGatewayListKeys": { + "$ref": "./examples/ApiManagementGatewayListKeys.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Gateway keys.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayKeysContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey": { + "post": { + "tags": [ + "GatewayRegenerateKey" + ], + "operationId": "Gateway_RegenerateKey", + "description": "Regenerates specified gateway key invalidating any tokens created with it.", + "x-ms-examples": { + "ApiManagementGatewayRegenerateKey": { + "$ref": "./examples/ApiManagementGatewayRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayKeyRegenerationRequestContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Key successfully regenerated" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken": { + "post": { + "tags": [ + "GatewayGenerateToken" + ], + "operationId": "Gateway_GenerateToken", + "description": "Gets the Shared Access Authorization Token for the gateway.", + "x-ms-examples": { + "ApiManagementGatewayGenerateToken": { + "$ref": "./examples/ApiManagementGatewayGenerateToken.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayTokenRequestContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the authorization token for the gateway.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayTokenContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations": { + "get": { + "tags": [ + "GatewayHostnameConfiguration" + ], + "operationId": "GatewayHostnameConfiguration_ListByService", + "description": "Lists the collection of hostname configurations for the specified gateway.", + "x-ms-examples": { + "ApiManagementListGatewayHostnameConfigurations": { + "$ref": "./examples/ApiManagementListGatewayHostnameConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Collection of hostname configuration entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}": { + "head": { + "tags": [ + "GatewayHostnameConfiguration" + ], + "operationId": "GatewayHostnameConfiguration_GetEntityTag", + "description": "Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.", + "x-ms-examples": { + "ApiManagementHeadGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementHeadGatewayHostnameConfiguration.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Gateway entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "GatewayHostnameConfiguration" + ], + "operationId": "GatewayHostnameConfiguration_Get", + "description": "Get details of a hostname configuration", + "x-ms-examples": { + "ApiManagementGetGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementGetGatewayHostnameConfiguration.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Gateway entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GatewayHostnameConfiguration" + ], + "operationId": "GatewayHostnameConfiguration_CreateOrUpdate", + "description": "Creates of updates hostname configuration for a Gateway.", + "x-ms-examples": { + "ApiManagementCreateGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementCreateGatewayHostnameConfiguration.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new Gateway hostname configuration was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" + } + }, + "200": { + "description": "The Gateway hostname configuration details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GatewayHostnameConfiguration" + ], + "operationId": "GatewayHostnameConfiguration_Delete", + "description": "Deletes the specified hostname configuration from the specified Gateway.", + "x-ms-examples": { + "ApiManagementDeleteGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementDeleteGatewayHostnameConfiguration.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Hostname configuration was successfully removed from Gateway." + }, + "204": { + "description": "Hostname configuration successfully removed by previous request or does not exist in Gateway." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis": { + "get": { + "tags": [ + "GatewayApi" + ], + "operationId": "GatewayApi_ListByService", + "description": "Lists a collection of the APIs associated with a gateway.", + "x-ms-examples": { + "ApiManagementListGatewayApis": { + "$ref": "./examples/ApiManagementListGatewayApis.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of Api entities in the gateway.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/ApiContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}": { + "head": { + "tags": [ + "GatewayApi" + ], + "operationId": "GatewayApi_GetEntityTag", + "description": "Checks that API entity specified by identifier is associated with the Gateway entity.", + "x-ms-examples": { + "ApiManagementHeadGatewayApi": { + "$ref": "./examples/ApiManagementHeadGatewayApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Gateway entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GatewayApi" + ], + "operationId": "GatewayApi_CreateOrUpdate", + "description": "Adds an API to the specified Gateway.", + "x-ms-examples": { + "ApiManagementCreateGatewayApi": { + "$ref": "./examples/ApiManagementCreateGatewayApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "./definitions.json#/definitions/AssociationContract" + } + } + ], + "responses": { + "201": { + "description": "The API was successfully added to the Gateway.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + } + }, + "200": { + "description": "The specified API is already added to the Gateway.", + "schema": { + "$ref": "./definitions.json#/definitions/ApiContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GatewayApi" + ], + "operationId": "GatewayApi_Delete", + "description": "Deletes the specified API from the specified Gateway.", + "x-ms-examples": { + "ApiManagementDeleteGatewayApi": { + "$ref": "./examples/ApiManagementDeleteGatewayApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "API was successfully removed from Gateway" + }, + "204": { + "description": "API successfully removed by previous request or does not exist in Gateway" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities": { + "get": { + "tags": [ + "GatewayCertificateAuthority" + ], + "operationId": "GatewayCertificateAuthority_ListByService", + "description": "Lists the collection of Certificate Authorities for the specified Gateway entity.", + "x-ms-examples": { + "ApiManagementListGatewaycertificateAuthorities": { + "$ref": "./examples/ApiManagementListGatewayCertificateAuthorities.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq, ne | |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Collection of Gateway Certificate Authority entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}": { + "head": { + "tags": [ + "GatewayCertificateAuthority" + ], + "operationId": "GatewayCertificateAuthority_GetEntityTag", + "description": "Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.", + "x-ms-examples": { + "ApiManagementHeadGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementHeadGatewayCertificateAuthority.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Gateway Certificate Authority entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "GatewayCertificateAuthority" + ], + "operationId": "GatewayCertificateAuthority_Get", + "description": "Get assigned Gateway Certificate Authority details.", + "x-ms-examples": { + "ApiManagementGetGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementGetGatewayCertificateAuthority.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Gateway Certificate Authority entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GatewayCertificateAuthority" + ], + "operationId": "GatewayCertificateAuthority_CreateOrUpdate", + "description": "Assign Certificate entity to Gateway entity as Certificate Authority.", + "x-ms-examples": { + "ApiManagementCreateGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementCreateGatewayCertificateAuthority.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Certificate entity was successfully assigned to Gateway entity as Certificate Authority.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" + } + }, + "200": { + "description": "Gateway Certificate Authority details were successfully updated", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GatewayCertificateAuthority" + ], + "operationId": "GatewayCertificateAuthority_Delete", + "description": "Remove relationship between Certificate Authority and Gateway entity.", + "x-ms-examples": { + "ApiManagementDeleteGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementDeleteGatewayCertificateAuthority.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Certificate entity was successfully removed from Gateway entity as Certificate Authority." + }, + "204": { + "description": "Certificate was successfully removed from Gateway entity as Certificate Authority by one of the previous requests or never assigned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimgroups.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimgroups.json index 0e4e9aa5..57aed2ab 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimgroups.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimgroups.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on Group entity in your Azure API Management deployment. Groups are used to manage the visibility of products to developers. Each API Management service instance comes with the following immutable system groups whose membership is automatically managed by API Management. - **Administrators** - Azure subscription administrators are members of this group. - **Developers** - Authenticated developer portal users fall into this group. - **Guests** - Unauthenticated developer portal users are placed into this group. In addition to these system groups, administrators can create custom groups or [leverage external groups in associated Azure Active Directory tenants](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-add-an-external-azure-active-directory-group). Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. A user can be a member of more than one group.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups": { "get": { "tags": [ - "Groups" + "Group" ], "operationId": "Group_ListByService", "description": "Lists a collection of groups defined within a service instance.", @@ -61,7 +61,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| type | eq, ne | N/A |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | eq | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -80,20 +80,26 @@ "200": { "description": "Lists a collection of Group entities.", "schema": { - "$ref": "#/definitions/GroupCollection" + "$ref": "./definitions.json#/definitions/GroupCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/GroupContract" + "x-ms-odata": "./definitions.json#/definitions/GroupContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}": { "head": { "tags": [ - "Groups" + "Group" ], "operationId": "Group_GetEntityTag", "description": "Gets the entity state (Etag) version of the group specified by its identifier.", @@ -110,7 +116,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -139,7 +145,7 @@ }, "get": { "tags": [ - "Groups" + "Group" ], "operationId": "Group_Get", "description": "Gets the details of the group specified by its identifier.", @@ -156,7 +162,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -169,7 +175,7 @@ "200": { "description": "The response body contains the specified Group entity.", "schema": { - "$ref": "#/definitions/GroupContract" + "$ref": "./definitions.json#/definitions/GroupContract" }, "headers": { "ETag": { @@ -188,7 +194,7 @@ }, "put": { "tags": [ - "Groups" + "Group" ], "operationId": "Group_CreateOrUpdate", "description": "Creates or Updates a group.", @@ -208,14 +214,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/GroupCreateParameters" + "$ref": "./definitions.json#/definitions/GroupCreateParameters" }, "description": "Create parameters." }, @@ -231,15 +237,27 @@ ], "responses": { "201": { - "description": "Group was created succesfully.", + "description": "Group was created successfully.", "schema": { - "$ref": "#/definitions/GroupContract" + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { "description": "Group already exists.", "schema": { - "$ref": "#/definitions/GroupContract" + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -252,7 +270,7 @@ }, "patch": { "tags": [ - "Groups" + "Group" ], "operationId": "Group_Update", "description": "Updates the details of the group specified by its identifier.", @@ -269,14 +287,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/GroupUpdateParameters" + "$ref": "./definitions.json#/definitions/GroupUpdateParameters" }, "description": "Update parameters." }, @@ -291,8 +309,17 @@ } ], "responses": { - "204": { - "description": "The group details were successfully updated." + "200": { + "description": "The group details were successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -304,7 +331,7 @@ }, "delete": { "tags": [ - "Groups" + "Group" ], "operationId": "Group_Delete", "description": "Deletes specific group of the API Management service instance.", @@ -321,7 +348,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -352,10 +379,10 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users": { "get": { "tags": [ - "GroupUsers" + "GroupUser" ], "operationId": "GroupUser_List", - "description": "Lists a collection of the members of the group, specified by its identifier.", + "description": "Lists a collection of user entities associated with the group.", "x-ms-examples": { "ApiManagementListGroupUsers": { "$ref": "./examples/ApiManagementListGroupUsers.json" @@ -369,14 +396,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|------------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | N/A |\n| registrationDate | ge, le, eq, ne, gt, lt | N/A |\n| note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -395,7 +422,7 @@ "200": { "description": "Lists a collection of user entities associated with the group.", "schema": { - "$ref": "./apimusers.json#/definitions/UserCollection" + "$ref": "./definitions.json#/definitions/UserCollection" } }, "default": { @@ -408,13 +435,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "./apimusers.json#/definitions/UserContract" + "x-ms-odata": "./definitions.json#/definitions/UserContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{uid}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}": { "head": { "tags": [ - "GroupUsers" + "GroupUser" ], "operationId": "GroupUser_CheckEntityExists", "description": "Checks that user entity specified by identifier is associated with the group entity.", @@ -431,10 +458,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { - "$ref": "./apimusers.json#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -447,7 +474,7 @@ "204": { "description": "Entity exists" }, - "404" : { + "404": { "description": "Entity does not exists." }, "default": { @@ -458,12 +485,12 @@ } } }, - "put": { + "put": { "tags": [ - "GroupUsers" + "GroupUser" ], "operationId": "GroupUser_Create", - "description": "Adds a user to the specified group.", + "description": "Add existing user to existing group", "x-ms-examples": { "ApiManagementCreateGroupUser": { "$ref": "./examples/ApiManagementCreateGroupUser.json" @@ -477,10 +504,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { - "$ref": "./apimusers.json#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -493,13 +520,13 @@ "201": { "description": "The user was successfully added to the group.", "schema": { - "$ref": "./apimusers.json#/definitions/UserContract" + "$ref": "./definitions.json#/definitions/UserContract" } }, "200": { "description": "The specified user is already a member of the specified group.", "schema": { - "$ref": "./apimusers.json#/definitions/UserContract" + "$ref": "./definitions.json#/definitions/UserContract" } }, "default": { @@ -512,7 +539,7 @@ }, "delete": { "tags": [ - "GroupUsers" + "GroupUser" ], "operationId": "GroupUser_Delete", "description": "Remove existing user from existing group.", @@ -529,10 +556,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { - "$ref": "./apimusers.json#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -558,178 +585,6 @@ } } }, - "definitions": { - "GroupCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GroupContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Group list representation." - }, - "GroupContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GroupContractProperties", - "description": "Group entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Contract details." - }, - "GroupContractProperties": { - "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": { - "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": { - "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": { - "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": { - "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." - } - }, - "parameters": { - "GroupIdParameter": { - "name": "groupId", - "in": "path", - "required": true, - "type": "string", - "description": "Group identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimidentityprovider.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimidentityprovider.json index 0297039b..b7785af9 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimidentityprovider.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimidentityprovider.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on Identity Provider entity associated with your Azure API Management deployment. Setting up an external Identity Provider for authentication can help you manage the developer portal logins using the OAuth2 flow.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -50,9 +50,6 @@ } }, "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" }, @@ -61,16 +58,16 @@ }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "responses": { "200": { "description": "Lists a collection of Identity Providers.", "schema": { - "$ref": "#/definitions/IdentityProviderList" + "$ref": "./definitions.json#/definitions/IdentityProviderList" } }, "default": { @@ -79,6 +76,9 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -95,9 +95,6 @@ } }, "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" }, @@ -105,20 +102,23 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/IdentityProviderNameParameter" + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Specified identity provider entity exists and current entity state version is present in the ETag header.", "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -129,7 +129,7 @@ } } }, - "get": { + "get": { "tags": [ "IdentityProvider" ], @@ -141,9 +141,6 @@ } }, "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" }, @@ -151,17 +148,20 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/IdentityProviderNameParameter" + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The response body contains the specified IdentityProvider entity configuration details.", "schema": { - "$ref": "#/definitions/IdentityProviderContract" + "$ref": "./definitions.json#/definitions/IdentityProviderContract" }, "headers": { "ETag": { @@ -197,14 +197,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/IdentityProviderNameParameter" + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/IdentityProviderContract" + "$ref": "./definitions.json#/definitions/IdentityProviderCreateContract" }, "description": "Create parameters." }, @@ -221,14 +221,26 @@ "responses": { "201": { "description": "IdentityProvider configuration were successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/IdentityProviderContract" + "$ref": "./definitions.json#/definitions/IdentityProviderContract" } }, "200": { "description": "The existing Identity Provider was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/IdentityProviderContract" + "$ref": "./definitions.json#/definitions/IdentityProviderContract" } }, "default": { @@ -241,7 +253,7 @@ }, "patch": { "tags": [ - "IdentityProviders" + "IdentityProvider" ], "operationId": "IdentityProvider_Update", "description": "Updates an existing IdentityProvider configuration.", @@ -258,14 +270,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/IdentityProviderNameParameter" + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/IdentityProviderUpdateParameters" + "$ref": "./definitions.json#/definitions/IdentityProviderUpdateParameters" }, "description": "Update parameters." }, @@ -280,8 +292,17 @@ } ], "responses": { - "204": { - "description": "The existing identity provider configuration was successfully updated." + "200": { + "description": "The existing Identity Provider was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/IdentityProviderContract" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -310,7 +331,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/IdentityProviderNameParameter" + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -337,216 +358,59 @@ } } } - } - }, - "definitions": { - "IdentityProviderContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IdentityProviderContractProperties", - "description": "Identity Provider contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Identity Provider details." - }, - "IdentityProviderContractProperties": { - "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": { - "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" - } - ], - "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." - }, - "IdentityProviderList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IdentityProviderContract" - }, - "description": "Identity Provider configuration values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "List of all the Identity Providers configured on the service instance." - }, - "IdentityProviderUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IdentityProviderUpdateProperties", - "description": "Identity Provider update properties." - } - }, - "description": "Parameters supplied to update Identity Provider" - }, - "IdentityProviderUpdateProperties": { - "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": { - "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." }, - "IdentityProviderBaseParameters": { - "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." - }, - "allowedTenants": { - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 32, - "description": "List of Allowed Tenants when configuring Azure Active Directory login." - }, - "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 + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}/listSecrets": { + "post": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_ListSecrets", + "description": "Gets the client secret details of the Identity Provider.", + "x-ms-examples": { + "ApiManagementIdentityProviderListSecrets": { + "$ref": "./examples/ApiManagementIdentityProviderListSecrets.json" + } }, - "passwordResetPolicyName": { - "type": "string", - "description": "Password Reset Policy Name. Only applies to AAD B2C Identity Provider.", - "minLength": 1 - } - }, - "description": "Identity Provider Base Parameter Properties." - } - }, - "parameters": { - "IdentityProviderNameParameter": { - "name": "identityProviderName", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "facebook", - "google", - "microsoft", - "twitter", - "aad", - "aadB2C" - ], - "x-ms-enum": { - "name": "IdentityProviderType", - "modelAsString": true, - "values": [ + "parameters": [ { - "value": "facebook", - "description": "Facebook as Identity provider." + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" }, { - "value": "google", - "description": "Google as Identity provider." + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "value": "microsoft", - "description": "Microsoft Live as Identity provider." + "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" }, { - "value": "twitter", - "description": "Twitter as Identity provider." + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, { - "value": "aad", - "description": "Azure Active Directory as Identity provider." + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the client secret.", + "schema": { + "$ref": "./definitions.json#/definitions/ClientSecretContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, - { - "value": "aadB2C", - "description": "Azure Active Directory B2C as Identity provider." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } - ] - }, - "description": "Identity Provider Type identifier.", - "x-ms-parameter-location": "method" + } + } } - } -} \ No newline at end of file + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimissues.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimissues.json index 749225eb..a5da0317 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimissues.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimissues.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use this REST API to get all the issues across an Azure Api Management service.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,12 +37,12 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues": { "get": { "tags": [ - "Issues" + "Issue" ], "operationId": "Issue_ListByService", "description": "Lists a collection of issues in the specified service instance.", "x-ms-examples": { - "ApiManagementListLoggers": { + "ApiManagementListIssues": { "$ref": "./examples/ApiManagementListIssues.json" } }, @@ -58,7 +58,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| state | eq | |\n| userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -77,7 +77,7 @@ "200": { "description": "Lists a collection of Issue entities.", "schema": { - "$ref": "./apimapis.json#/definitions/IssueCollection" + "$ref": "./definitions.json#/definitions/IssueCollection" } }, "default": { @@ -90,8 +90,61 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "./apimapis.json#/definitions/IssueContract" + "x-ms-odata": "./definitions.json#/definitions/IssueContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues/{issueId}": { + "get": { + "tags": [ + "Issue" + ], + "operationId": "Issue_Get", + "description": "Gets API Management issue details", + "x-ms-examples": { + "ApiManagementGetIssue": { + "$ref": "./examples/ApiManagementGetIssue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get the details of the issue.", + "schema": { + "$ref": "./definitions.json#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } } } - } -} \ No newline at end of file + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimloggers.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimloggers.json index a7be9704..8db69af7 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimloggers.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimloggers.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on logger entity Azure API Management deployment.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 EventHub.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers": { "get": { "tags": [ - "Loggers" + "Logger" ], "operationId": "Logger_ListByService", "description": "Lists a collection of loggers in the specified service instance.", @@ -61,7 +61,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| type | eq | |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -80,7 +80,7 @@ "200": { "description": "Lists a collection of Logger entities.", "schema": { - "$ref": "#/definitions/LoggerCollection" + "$ref": "./definitions.json#/definitions/LoggerCollection" } }, "default": { @@ -93,13 +93,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/LoggerContract" + "x-ms-odata": "./definitions.json#/definitions/LoggerContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}": { "head": { "tags": [ - "Loggers" + "Logger" ], "operationId": "Logger_GetEntityTag", "description": "Gets the entity state (Etag) version of the logger specified by its identifier.", @@ -116,7 +116,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/LoggerIdParameter" + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -129,10 +129,10 @@ "200": { "description": "Specified logger entity exists and current entity state version is present in the ETag header.", "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -143,9 +143,9 @@ } } }, - "get": { + "get": { "tags": [ - "Loggers" + "Logger" ], "operationId": "Logger_Get", "description": "Gets the details of the logger specified by its identifier.", @@ -162,7 +162,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/LoggerIdParameter" + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -175,7 +175,7 @@ "200": { "description": "The response body contains the specified Logger entity.", "schema": { - "$ref": "#/definitions/LoggerContract" + "$ref": "./definitions.json#/definitions/LoggerContract" }, "headers": { "ETag": { @@ -194,7 +194,7 @@ }, "put": { "tags": [ - "Loggers" + "Logger" ], "operationId": "Logger_CreateOrUpdate", "description": "Creates or Updates a logger.", @@ -214,14 +214,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/LoggerIdParameter" + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/LoggerContract" + "$ref": "./definitions.json#/definitions/LoggerContract" }, "description": "Create parameters." }, @@ -239,13 +239,25 @@ "201": { "description": "Logger was successfully created.", "schema": { - "$ref": "#/definitions/LoggerContract" + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { "description": "The existing logger was successfully updated.", "schema": { - "$ref": "#/definitions/LoggerContract" + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -258,7 +270,7 @@ }, "patch": { "tags": [ - "Loggers" + "Logger" ], "operationId": "Logger_Update", "description": "Updates an existing logger.", @@ -275,14 +287,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/LoggerIdParameter" + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/LoggerUpdateContract" + "$ref": "./definitions.json#/definitions/LoggerUpdateContract" }, "description": "Update parameters." }, @@ -297,8 +309,17 @@ } ], "responses": { - "204": { - "description": "The existing logger was successfully updated." + "200": { + "description": "The existing logger was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -310,7 +331,7 @@ }, "delete": { "tags": [ - "Loggers" + "Logger" ], "operationId": "Logger_Delete", "description": "Deletes the specified logger.", @@ -327,7 +348,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/LoggerIdParameter" + "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -356,157 +377,6 @@ } } }, - "definitions": { - "LoggerCollection": { - "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": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/LoggerContractProperties", - "description": "Logger entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Logger details." - }, - "LoggerContractProperties": { - "properties": { - "loggerType": { - "type": "string", - "description": "Logger type.", - "enum": [ - "azureEventHub", - "applicationInsights" - ], - "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." - } - ] - } - }, - "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." - } - }, - "required": [ - "loggerType", - "credentials" - ], - "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": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/LoggerUpdateParameters", - "description": "Logger entity update contract properties." - } - }, - "description": "Logger update contract." - }, - "LoggerUpdateParameters": { - "properties": { - "loggerType": { - "type": "string", - "description": "Logger type.", - "enum": [ - "azureEventHub", - "applicationInsights" - ], - "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." - } - ] - } - }, - "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." - } - }, - "parameters": { - "LoggerIdParameter": { - "name": "loggerid", - "in": "path", - "required": true, - "type": "string", - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "description": "Logger identifier. Must be unique in the API Management service instance.", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnamedvalues.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnamedvalues.json new file mode 100644 index 00000000..068ccdc5 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnamedvalues.json @@ -0,0 +1,515 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on NamedValue entity associated with your Azure API Management deployment. API Management policies are a powerful capability of the system that allow the publisher to change the behavior of the API through configuration. Policies are a collection of statements that are executed sequentially on the request or response of an API. Policy statements can be constructed using literal text values, policy expressions, and NamedValues. Each API Management service instance has a NamedValues collection of key/value pairs that are global to the service instance. These NamedValues can be used to manage constant string values across all API configuration and policies.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues": { + "get": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_ListByService", + "description": "Lists a collection of named values defined within a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties" + }, + "x-ms-examples": { + "ApiManagementListNamedValues": { + "$ref": "./examples/ApiManagementListNamedValues.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "isKeyVaultRefreshFailed", + "in": "query", + "required": false, + "type": "boolean", + "description": "When set to true, the response contains only named value entities which failed refresh." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the named value entities for the specified API Management service instance.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/NamedValueContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}": { + "head": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_GetEntityTag", + "description": "Gets the entity state (Etag) version of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadNamedValue": { + "$ref": "./examples/ApiManagementHeadNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified named value entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_Get", + "description": "Gets the details of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetNamedValue": { + "$ref": "./examples/ApiManagementGetNamedValue.json" + }, + "ApiManagementGetNamedValueWithKeyVault": { + "$ref": "./examples/ApiManagementGetNamedValueWithKeyVault.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified named value entity. No secrets included", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_CreateOrUpdate", + "description": "Creates or updates named value.", + "x-ms-examples": { + "ApiManagementCreateNamedValue": { + "$ref": "./examples/ApiManagementCreateNamedValue.json" + }, + "ApiManagementCreateNamedValueWithKeyVault": { + "$ref": "./examples/ApiManagementCreateNamedValueWithKeyVault.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueCreateContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request to create or update named value was accepted." + }, + "201": { + "description": "Named value was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Named value was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_Update", + "description": "Updates the specific named value.", + "x-ms-examples": { + "ApiManagementUpdateNamedValue": { + "$ref": "./examples/ApiManagementUpdateNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request to create or update named value was accepted." + }, + "200": { + "description": "Named value was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_Delete", + "description": "Deletes specific named value from the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteNamedValue": { + "$ref": "./examples/ApiManagementDeleteNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Named value was successfully deleted." + }, + "204": { + "description": "Named value was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/listValue": { + "post": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_ListValue", + "description": "Gets the secret of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementNamedValueListValue": { + "$ref": "./examples/ApiManagementNamedValueListValue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified named value secret.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueSecretContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/refreshSecret": { + "post": { + "tags": [ + "NamedValue" + ], + "operationId": "NamedValue_RefreshSecret", + "description": "Refresh the secret of the named value specified by its identifier.", + "x-ms-examples": { + "ApiManagementRefreshNamedValue": { + "$ref": "./examples/ApiManagementRefreshNamedValue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request to refresh secret was accepted." + }, + "200": { + "description": "Named value was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnetworkstatus.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnetworkstatus.json index 0a5d95a5..eaa269cb 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnetworkstatus.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnetworkstatus.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for getting the network connectivity status of your Azure API Management deployment. When the API Management service is deployed inside a Virtual Network, it needs to have access to other Azure resources it depends on. This also gives details about the DNS Servers visible to Azure API Management deployment.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -103,7 +103,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/LocationNameParameter" + "$ref": "./apimanagement.json#/parameters/LocationNameParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -160,13 +160,23 @@ "type": "string", "format": "date-time", "description": "The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "resourceType": { + "type": "string", + "description": "Resource Type." + }, + "isOptional": { + "type": "boolean", + "description": "Whether this is optional." } }, "required": [ "name", "status", "lastUpdated", - "lastStatusChange" + "lastStatusChange", + "resourceType", + "isOptional" ], "description": "Details about connectivity to a resource." }, @@ -198,6 +208,10 @@ "items": { "$ref": "#/definitions/ConnectivityStatusContract" }, + "x-ms-identifiers": [ + "name", + "resourceType" + ], "description": "Gets the list of Connectivity Status to the Resources on which the service depends upon." } }, @@ -208,15 +222,5 @@ "description": "Network Status details." } }, - "parameters": { - "LocationNameParameter": { - "name": "locationName", - "in": "path", - "required": true, - "type": "string", - "description": "Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US.", - "minLength": 1, - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnotifications.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnotifications.json index 7abf971b..deb5ade0 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnotifications.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimnotifications.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on who is going to receive notifications associated with your Azure API Management deployment.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -42,7 +42,7 @@ "operationId": "Notification_ListByService", "description": "Lists a collection of properties defined within a service instance.", "x-ms-examples": { - "ApiManagementListNotification": { + "ApiManagementListNotifications": { "$ref": "./examples/ApiManagementListNotifications.json" } }, @@ -70,7 +70,13 @@ "200": { "description": "A Collection of the Notification for the specified API Management service instance.", "schema": { - "$ref": "#/definitions/NotificationCollection" + "$ref": "./definitions.json#/definitions/NotificationCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, @@ -99,7 +105,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/NotificationNameParameter" + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -112,7 +118,7 @@ "200": { "description": "The response body contains the specified Notification.", "schema": { - "$ref": "#/definitions/NotificationContract" + "$ref": "./definitions.json#/definitions/NotificationContract" } }, "default": { @@ -128,10 +134,10 @@ "Notification" ], "operationId": "Notification_CreateOrUpdate", - "description": "Updates an Notification.", + "description": "Create or Update API Management publisher notification.", "x-ms-examples": { - "ApiManagementGetNotification": { - "$ref": "./examples/ApiManagementGetNotification.json" + "ApiManagementCreateNotification": { + "$ref": "./examples/ApiManagementCreateNotification.json" } }, "parameters": [ @@ -142,7 +148,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/NotificationNameParameter" + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" @@ -158,7 +164,7 @@ "200": { "description": "Notification was successfully updated.", "schema": { - "$ref": "#/definitions/NotificationContract" + "$ref": "./definitions.json#/definitions/NotificationContract" } }, "default": { @@ -173,13 +179,13 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers": { "get": { "tags": [ - "Notification" + "NotificationRecipientUser" ], "operationId": "NotificationRecipientUser_ListByNotification", "description": "Gets the list of the Notification Recipient User subscribed to the notification.", "x-ms-examples": { - "ApiManagementListNotificationRecipientUser": { - "$ref": "./examples/ApiManagementListNotificationRecipientUser.json" + "ApiManagementListNotificationRecipientUsers": { + "$ref": "./examples/ApiManagementListNotificationRecipientUsers.json" } }, "parameters": [ @@ -190,7 +196,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/NotificationNameParameter" + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -203,7 +209,7 @@ "200": { "description": "The response body contains the Recipient User collection for the notification.", "schema": { - "$ref": "#/definitions/RecipientUserCollection" + "$ref": "./definitions.json#/definitions/RecipientUserCollection" } }, "default": { @@ -215,7 +221,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{uid}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}": { "head": { "tags": [ "NotificationRecipientUser" @@ -235,10 +241,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/NotificationNameParameter" + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" }, { - "$ref": "./apimusers.json#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -251,7 +257,7 @@ "204": { "description": "The User is subscribed to receive the notification." }, - "404" : { + "404": { "description": "Entity does not exists." }, "default": { @@ -269,8 +275,8 @@ "operationId": "NotificationRecipientUser_CreateOrUpdate", "description": "Adds the API Management User to the list of Recipients for the Notification.", "x-ms-examples": { - "ApiManagementCreateRecipientUser": { - "$ref": "./examples/ApiManagementCreateRecipientUser.json" + "ApiManagementCreateNotificationRecipientUser": { + "$ref": "./examples/ApiManagementCreateNotificationRecipientUser.json" } }, "parameters": [ @@ -281,10 +287,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/NotificationNameParameter" + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" }, { - "$ref": "./apimusers.json#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -297,13 +303,13 @@ "201": { "description": "Recipient User was successfully added to the notification list.", "schema": { - "$ref": "#/definitions/RecipientUserContract" + "$ref": "./definitions.json#/definitions/RecipientUserContract" } }, "200": { "description": "Recipient User is already part of the notification list.", "schema": { - "$ref": "#/definitions/RecipientUserContract" + "$ref": "./definitions.json#/definitions/RecipientUserContract" } }, "default": { @@ -333,10 +339,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/NotificationNameParameter" + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" }, { - "$ref": "./apimusers.json#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -369,8 +375,8 @@ "operationId": "NotificationRecipientEmail_ListByNotification", "description": "Gets the list of the Notification Recipient Emails subscribed to a notification.", "x-ms-examples": { - "ApiManagementListNotificationRecipientEmail": { - "$ref": "./examples/ApiManagementListNotificationRecipientEmail.json" + "ApiManagementListNotificationRecipientEmails": { + "$ref": "./examples/ApiManagementListNotificationRecipientEmails.json" } }, "parameters": [ @@ -381,7 +387,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/NotificationNameParameter" + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -394,7 +400,7 @@ "200": { "description": "The response body contains the Recipient Email collection subscribed to the notification.", "schema": { - "$ref": "#/definitions/RecipientEmailCollection" + "$ref": "./definitions.json#/definitions/RecipientEmailCollection" } }, "default": { @@ -426,10 +432,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/NotificationNameParameter" + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" }, { - "$ref": "#/parameters/EmailParameter" + "$ref": "./apimanagement.json#/parameters/EmailParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -442,7 +448,7 @@ "204": { "description": "The Users is subscribed to receive the notification." }, - "404" : { + "404": { "description": "The Users is not subscribed to receive the notification." }, "default": { @@ -460,8 +466,8 @@ "operationId": "NotificationRecipientEmail_CreateOrUpdate", "description": "Adds the Email address to the list of Recipients for the Notification.", "x-ms-examples": { - "ApiManagementCreateRecipientEmail": { - "$ref": "./examples/ApiManagementCreateRecipientEmail.json" + "ApiManagementCreateNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementCreateNotificationRecipientEmail.json" } }, "parameters": [ @@ -472,10 +478,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/NotificationNameParameter" + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" }, { - "$ref": "#/parameters/EmailParameter" + "$ref": "./apimanagement.json#/parameters/EmailParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -488,13 +494,13 @@ "201": { "description": "Recipient Email was successfully added to the notification list.", "schema": { - "$ref": "#/definitions/RecipientEmailContract" + "$ref": "./definitions.json#/definitions/RecipientEmailContract" } }, "200": { "description": "Recipient Email is already part of the notification list.", "schema": { - "$ref": "#/definitions/RecipientEmailContract" + "$ref": "./definitions.json#/definitions/RecipientEmailContract" } }, "default": { @@ -524,10 +530,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/NotificationNameParameter" + "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" }, { - "$ref": "#/parameters/EmailParameter" + "$ref": "./apimanagement.json#/parameters/EmailParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -553,219 +559,6 @@ } } }, - "definitions": { - "NotificationCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/NotificationContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Notification list representation." - }, - "NotificationContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NotificationContractProperties", - "description": "Notification entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Notification details." - }, - "NotificationContractProperties": { - "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." - }, - "RecipientsContractProperties": { - "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": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RecipientUserContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Recipient User list representation." - }, - "RecipientUserContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RecipientUsersContractProperties", - "description": "Recipient User entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Recipient User details." - }, - "RecipientUsersContractProperties": { - "properties": { - "userId": { - "type": "string", - "description": "API Management UserId subscribed to notification." - } - }, - "description": "Recipient User Contract Properties." - }, - "RecipientEmailCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RecipientEmailContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Recipient User list representation." - }, - "RecipientEmailContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RecipientEmailContractProperties", - "description": "Recipient Email contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Recipient Email details." - }, - "RecipientEmailContractProperties": { - "properties": { - "email": { - "type": "string", - "description": "User Email subscribed to notification." - } - }, - "description": "Recipient Email Contract Properties." - } - }, - "parameters": { - "NotificationNameParameter": { - "name": "notificationName", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "RequestPublisherNotificationMessage", - "PurchasePublisherNotificationMessage", - "NewApplicationNotificationMessage", - "BCC", - "NewIssuePublisherNotificationMessage", - "AccountClosedPublisher", - "QuotaLimitApproachingPublisherNotificationMessage" - ], - "x-ms-enum": { - "name": "NotificationName", - "modelAsString": true, - "values": [ - { - "value": "RequestPublisherNotificationMessage", - "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." - }, - { - "value": "PurchasePublisherNotificationMessage", - "description": "The following email recipients and users will receive email notifications about new API product subscriptions." - }, - { - "value": "NewApplicationNotificationMessage", - "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." - }, - { - "value": "BCC", - "description": "The following recipients will receive blind carbon copies of all emails sent to developers." - }, - { - "value": "NewIssuePublisherNotificationMessage", - "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." - }, - { - "value": "AccountClosedPublisher", - "description": "The following email recipients and users will receive email notifications when developer closes his account." - }, - { - "value": "QuotaLimitApproachingPublisherNotificationMessage", - "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." - } - ] - }, - "description": "Notification Name Identifier.", - "x-ms-parameter-location": "method" - }, - "EmailParameter": { - "name": "email", - "in": "path", - "required": true, - "type": "string", - "description": "Email identifier.", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimopenidconnectproviders.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimopenidconnectproviders.json index 2c2fd499..38fd4696 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimopenidconnectproviders.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimopenidconnectproviders.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on OpenId Connect Provider entity associated with your Azure API Management deployment. API Management allows you to access APIs secured with token from [OpenID Connect Provider ](http://openid.net/connect/) to be accessed from the Developer Console.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,10 +37,10 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders": { "get": { "tags": [ - "OpenIdConnectProviders" + "OpenidConnectProvider" ], "operationId": "OpenIdConnectProvider_ListByService", - "description": "Lists all OpenID Connect Providers.", + "description": "Lists of all the OpenId Connect Providers.", "x-ms-examples": { "ApiManagementListOpenIdConnectProviders": { "$ref": "./examples/ApiManagementListOpenIdConnectProviders.json" @@ -58,7 +58,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -77,20 +77,26 @@ "200": { "description": "Lists of all the OpenId Connect Providers.", "schema": { - "$ref": "#/definitions/OpenIdConnectProviderCollection" + "$ref": "./definitions.json#/definitions/OpenIdConnectProviderCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/OpenidConnectProviderContract" + "x-ms-odata": "./definitions.json#/definitions/OpenidConnectProviderContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}": { "head": { "tags": [ - "OpenIdConnectProviders" + "OpenidConnectProvider" ], "operationId": "OpenIdConnectProvider_GetEntityTag", "description": "Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.", @@ -107,7 +113,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/OpenIdConnectIdParameter" + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -120,10 +126,10 @@ "200": { "description": "Specified openidConnectProvider entity exists and current entity state version is present in the ETag header.", "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -134,12 +140,12 @@ } } }, - "get": { + "get": { "tags": [ - "OpenIdConnectProviders" + "OpenidConnectProvider" ], "operationId": "OpenIdConnectProvider_Get", - "description": "Gets specific OpenID Connect Provider.", + "description": "Gets specific OpenID Connect Provider without secrets.", "x-ms-examples": { "ApiManagementGetOpenIdConnectProvider": { "$ref": "./examples/ApiManagementGetOpenIdConnectProvider.json" @@ -153,7 +159,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/OpenIdConnectIdParameter" + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -164,9 +170,9 @@ ], "responses": { "200": { - "description": "The response body contains the specified OpenId Connect Provider entity.", + "description": "The response body contains the specified OpenId Connect Provider entity without secrets.", "schema": { - "$ref": "#/definitions/OpenidConnectProviderContract" + "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" }, "headers": { "ETag": { @@ -185,7 +191,7 @@ }, "put": { "tags": [ - "OpenIdConnectProviders" + "OpenidConnectProvider" ], "operationId": "OpenIdConnectProvider_CreateOrUpdate", "description": "Creates or updates the OpenID Connect Provider.", @@ -202,14 +208,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/OpenIdConnectIdParameter" + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OpenidConnectProviderContract" + "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" }, "description": "Create parameters." }, @@ -226,14 +232,26 @@ "responses": { "201": { "description": "OpenIdConnect Provider was successfully created.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/OpenidConnectProviderContract" + "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" } }, "200": { "description": "OpenIdConnect Provider was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/OpenidConnectProviderContract" + "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" } }, "default": { @@ -246,7 +264,7 @@ }, "patch": { "tags": [ - "OpenIdConnectProviders" + "OpenidConnectProvider" ], "operationId": "OpenIdConnectProvider_Update", "description": "Updates the specific OpenID Connect Provider.", @@ -263,14 +281,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/OpenIdConnectIdParameter" + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OpenidConnectProviderUpdateContract" + "$ref": "./definitions.json#/definitions/OpenidConnectProviderUpdateContract" }, "description": "Update parameters." }, @@ -285,8 +303,17 @@ } ], "responses": { - "204": { - "description": "OpenId Connect Provider was successfully updated." + "200": { + "description": "OpenIdConnect Provider was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -298,7 +325,7 @@ }, "delete": { "tags": [ - "OpenIdConnectProviders" + "OpenidConnectProvider" ], "operationId": "OpenIdConnectProvider_Delete", "description": "Deletes specific OpenID Connect Provider of the API Management service instance.", @@ -315,7 +342,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/OpenIdConnectIdParameter" + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -342,118 +369,59 @@ } } } - } - }, - "definitions": { - "OpenIdConnectProviderCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/OpenidConnectProviderContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged OpenIdProviders list representation." - }, - "OpenidConnectProviderContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OpenidConnectProviderContractProperties", - "description": "OpenId Connect Provider contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "OpenId Connect Provider details." - }, - "OpenidConnectProviderContractProperties": { - "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": { - "type": "string", - "description": "Client Secret of developer console which is the client application." - } - }, - "required": [ - "displayName", - "metadataEndpoint", - "clientId" - ], - "description": "OpenID Connect Providers Contract." - }, - "OpenidConnectProviderUpdateContract": { - "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": { - "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." + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}/listSecrets": { + "post": { + "tags": [ + "OpenidConnectProvider" + ], + "operationId": "OpenIdConnectProvider_ListSecrets", + "description": "Gets the client secret details of the OpenID Connect Provider.", + "x-ms-examples": { + "ApiManagementOpenidConnectProviderListSecrets": { + "$ref": "./examples/ApiManagementOpenidConnectProviderListSecrets.json" + } }, - "clientSecret": { - "type": "string", - "description": "Client Secret of developer console which is the client application." + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified OpenId Connect Provider secrets.", + "schema": { + "$ref": "./definitions.json#/definitions/ClientSecretContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } - }, - "description": "Parameters supplied to the Update OpenID Connect Provider operation." + } } }, - "parameters": { - "OpenIdConnectIdParameter": { - "name": "opid", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the OpenID Connect Provider.", - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimoutbounddependency.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimoutbounddependency.json new file mode 100644 index 00000000..06d9cc21 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimoutbounddependency.json @@ -0,0 +1,161 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for getting the outbound network dependency of your Azure API Management deployment. When the API Management service is deployed inside a Virtual Network, it needs to have access to other Azure resources it depends on. This also gives details about the DNS Servers visible to Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "OutboundNetworkDependenciesEndpoints" + ], + "operationId": "OutboundNetworkDependenciesEndpoints_ListByService", + "description": "Gets the network endpoints of all outbound dependencies of a ApiManagement service.", + "x-ms-examples": { + "ApiManagementServiceGetOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OutboundEnvironmentEndpointList": { + "description": "Collection of Outbound Environment Endpoints", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to.", + "type": "object", + "properties": { + "category": { + "description": "The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that the Api Management Service reaches the service at.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [ + "domainName" + ] + } + } + }, + "EndpointDependency": { + "description": "A domain name that a service is reached at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports used when connecting to DomainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [ + "region", + "port" + ] + } + } + }, + "EndpointDetail": { + "description": "Current TCP connectivity information from the Api Management Service to a single endpoint.", + "type": "object", + "properties": { + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "region": { + "description": "The region of the dependency.", + "type": "string" + } + } + } + }, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimpolicies.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimpolicies.json new file mode 100644 index 00000000..84d1b119 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimpolicies.json @@ -0,0 +1,304 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Global Policies in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies": { + "get": { + "tags": [ + "Policy" + ], + "operationId": "Policy_ListByService", + "description": "Lists all the Global Policy definitions of the Api Management service.", + "x-ms-examples": { + "ApiManagementListPolicies": { + "$ref": "./examples/ApiManagementListPolicies.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns an array of Policy Contracts.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}": { + "head": { + "tags": [ + "Policy" + ], + "operationId": "Policy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Global policy definition in the Api Management service.", + "x-ms-examples": { + "ApiManagementHeadPolicy": { + "$ref": "./examples/ApiManagementHeadPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Policy" + ], + "operationId": "Policy_Get", + "description": "Get the Global policy definition of the Api Management service.", + "x-ms-examples": { + "ApiManagementGetPolicy": { + "$ref": "./examples/ApiManagementGetPolicy.json" + }, + "ApiManagementGetPolicyFormat": { + "$ref": "./examples/ApiManagementGetPolicyFormat.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get the Global policy definition of the Api Management service.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Policy" + ], + "operationId": "Policy_CreateOrUpdate", + "description": "Creates or updates the global policy configuration of the Api Management service.", + "x-ms-examples": { + "ApiManagementCreatePolicy": { + "$ref": "./examples/ApiManagementCreatePolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Global policy configuration was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "Global policy configuration of the Api Management service was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Policy" + ], + "operationId": "Policy_Delete", + "description": "Deletes the global policy configuration of the Api Management Service.", + "x-ms-examples": { + "ApiManagementDeletePolicy": { + "$ref": "./examples/ApiManagementDeletePolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Policy was successfully removed" + }, + "204": { + "description": "Policy successfully removed by previous request or does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimpolicydescriptions.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimpolicydescriptions.json new file mode 100644 index 00000000..39bee841 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimpolicydescriptions.json @@ -0,0 +1,100 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing retrieving a collection of policy snippets available in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions": { + "get": { + "tags": [ + "PolicyDescription" + ], + "operationId": "PolicyDescription_ListByService", + "description": "Lists all policy descriptions.", + "x-ms-examples": { + "ApiManagementListPolicyDescriptions": { + "$ref": "./examples/ApiManagementListPolicyDescriptions.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "scope", + "in": "query", + "required": false, + "type": "string", + "description": "Policy scope.", + "enum": [ + "Tenant", + "Product", + "Api", + "Operation", + "All" + ], + "x-ms-enum": { + "name": "PolicyScopeContract", + "modelAsString": false + } + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns an array of policy descriptions.", + "schema": { + "$ref": "./definitions.json#/definitions/PolicyDescriptionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimportalrevisions.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimportalrevisions.json new file mode 100644 index 00000000..20a19d85 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimportalrevisions.json @@ -0,0 +1,326 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions": { + "get": { + "tags": [ + "PortalRevision" + ], + "operationId": "PortalRevision_ListByService", + "description": "Lists developer portal's revisions.", + "x-ms-examples": { + "ApiManagementListPortalRevisions": { + "$ref": "./examples/ApiManagementListPortalRevisions.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n\r\n|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|isCurrent | eq, ne | |\n" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists portal's revisions.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}": { + "head": { + "tags": [ + "PortalRevision" + ], + "operationId": "PortalRevision_GetEntityTag", + "description": "Gets the developer portal revision specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadPortalRevision": { + "$ref": "./examples/ApiManagementHeadPortalRevision.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The specified portal revision entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "PortalRevision" + ], + "operationId": "PortalRevision_Get", + "description": "Gets the developer portal's revision specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetPortalRevision": { + "$ref": "./examples/ApiManagementGetPortalRevision.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the specified portal's revision.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PortalRevision" + ], + "operationId": "PortalRevision_CreateOrUpdate", + "description": "Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.", + "x-ms-examples": { + "ApiManagementCreatePortalRevision": { + "$ref": "./examples/ApiManagementCreatePortalRevision.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request to create a developer portal revision was accepted." + }, + "201": { + "description": "The developer portal revision was successfully created.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "PortalRevision" + ], + "operationId": "PortalRevision_Update", + "description": "Updates the description of specified portal revision or makes it current.", + "x-ms-examples": { + "ApiManagementUpdatePortalRevision": { + "$ref": "./examples/ApiManagementUpdatePortalRevision.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionContract" + } + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Request to update developer portal revision was accepted." + }, + "200": { + "description": "Developer portal revision was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalRevisionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimportalsettings.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimportalsettings.json index 86bd3943..806022d3 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimportalsettings.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimportalsettings.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on PortalSettings entity associated with your Azure API Management deployment. Using this entity you can manage settings for a Developer Portal.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -34,6 +34,48 @@ } }, "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings": { + "get": { + "tags": [ + "PortalSettings" + ], + "operationId": "PortalSettings_ListByService", + "description": "Lists a collection of portalsettings defined within a service instance..", + "x-ms-examples": { + "ApiManagementListPortalSettings": { + "$ref": "./examples/ApiManagementListPortalSettings.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Portal Settings entities.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalSettingsCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signin": { "head": { "tags": [ @@ -83,7 +125,7 @@ "SignInSettings" ], "operationId": "SignInSettings_Get", - "description": "Get Sign-In settings.", + "description": "Get Sign In Settings for the Portal", "x-ms-examples": { "ApiManagementPortalSettingsGetSignIn": { "$ref": "./examples/ApiManagementPortalSettingsGetSignIn.json" @@ -107,7 +149,7 @@ "200": { "description": "Sign-In settings.", "schema": { - "$ref": "#/definitions/PortalSigninSettings" + "$ref": "./definitions.json#/definitions/PortalSigninSettings" }, "headers": { "ETag": { @@ -115,6 +157,12 @@ "type": "string" } } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } } }, @@ -141,7 +189,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/PortalSigninSettings" + "$ref": "./definitions.json#/definitions/PortalSigninSettings" }, "description": "Update Sign-In settings." }, @@ -190,10 +238,13 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/PortalSigninSettings" + "$ref": "./definitions.json#/definitions/PortalSigninSettings" }, "description": "Create or update parameters." }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -205,7 +256,7 @@ "200": { "description": "Sign-In settings was successfully updated.", "schema": { - "$ref": "#/definitions/PortalSigninSettings" + "$ref": "./definitions.json#/definitions/PortalSigninSettings" } }, "default": { @@ -266,7 +317,7 @@ "SignUpSettings" ], "operationId": "SignUpSettings_Get", - "description": "Get Sign-Up settings.", + "description": "Get Sign Up Settings for the Portal", "x-ms-examples": { "ApiManagementPortalSettingsGetSignUp": { "$ref": "./examples/ApiManagementPortalSettingsGetSignUp.json" @@ -290,7 +341,7 @@ "200": { "description": "Sign-Up settings.", "schema": { - "$ref": "#/definitions/PortalSignupSettings" + "$ref": "./definitions.json#/definitions/PortalSignupSettings" }, "headers": { "ETag": { @@ -298,6 +349,12 @@ "type": "string" } } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } } }, @@ -324,7 +381,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/PortalSignupSettings" + "$ref": "./definitions.json#/definitions/PortalSignupSettings" }, "description": "Update Sign-Up settings." }, @@ -373,10 +430,13 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/PortalSignupSettings" + "$ref": "./definitions.json#/definitions/PortalSignupSettings" }, "description": "Create or update parameters." }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -388,7 +448,7 @@ "200": { "description": "Sign-Up settings was successfully updated.", "schema": { - "$ref": "#/definitions/PortalSignupSettings" + "$ref": "./definitions.json#/definitions/PortalSignupSettings" } }, "default": { @@ -449,7 +509,7 @@ "DelegationSettings" ], "operationId": "DelegationSettings_Get", - "description": "Get Delegation settings.", + "description": "Get Delegation Settings for the Portal.", "x-ms-examples": { "ApiManagementPortalSettingsGetDelegation": { "$ref": "./examples/ApiManagementPortalSettingsGetDelegation.json" @@ -473,7 +533,7 @@ "200": { "description": "Delegation settings.", "schema": { - "$ref": "#/definitions/PortalDelegationSettings" + "$ref": "./definitions.json#/definitions/PortalDelegationSettings" }, "headers": { "ETag": { @@ -481,6 +541,12 @@ "type": "string" } } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } } }, @@ -507,7 +573,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/PortalDelegationSettings" + "$ref": "./definitions.json#/definitions/PortalDelegationSettings" }, "description": "Update Delegation settings." }, @@ -556,10 +622,13 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/PortalDelegationSettings" + "$ref": "./definitions.json#/definitions/PortalDelegationSettings" }, "description": "Create or update parameters." }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -571,7 +640,7 @@ "200": { "description": "Delegation settings was successfully updated.", "schema": { - "$ref": "#/definitions/PortalDelegationSettings" + "$ref": "./definitions.json#/definitions/PortalDelegationSettings" } }, "default": { @@ -582,132 +651,49 @@ } } } - } - }, - "definitions": { - "PortalSigninSettings": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PortalSigninSettingProperties", - "description": "Sign-in settings contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Sign-In settings for the Developer Portal." - }, - "PortalSigninSettingProperties": { - "properties": { - "enabled": { - "type": "boolean", - "description": "Redirect Anonymous users to the Sign-In page." - } - }, - "description": "Sign-in settings contract properties." - }, - "PortalSignupSettings": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PortalSignupSettingsProperties", - "description": "Sign-up settings contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Sign-Up settings for a developer portal." }, - "PortalSignupSettingsProperties": { - "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." - }, - "TermsOfServiceProperties": { - "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." - }, - "PortalDelegationSettings": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PortalDelegationSettingsProperties", - "description": "Delegation settings contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Delegation settings for a developer portal." - }, - "PortalDelegationSettingsProperties": { - "properties": { - "url": { - "type": "string", - "description": "A delegation Url." - }, - "validationKey": { - "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." + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation/listSecrets": { + "post": { + "tags": [ + "DelegationSettings" + ], + "operationId": "DelegationSettings_ListSecrets", + "description": "Gets the secret validation key of the DelegationSettings.", + "x-ms-examples": { + "ApiManagementListSecretsPortalSettings": { + "$ref": "./examples/ApiManagementListSecretsPortalSettingsValidationKey.json" + } }, - "userRegistration": { - "$ref": "#/definitions/RegistrationDelegationSettingsProperties", - "description": "User registration delegation settings." - } - }, - "description": "Delegation settings contract properties." - }, - "SubscriptionsDelegationSettingsProperties": { - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable or disable delegation for subscriptions." - } - }, - "description": "Subscriptions delegation settings properties." - }, - "RegistrationDelegationSettingsProperties": { - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable or disable delegation for user registration." + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the validation key.", + "schema": { + "$ref": "./definitions.json#/definitions/PortalSettingValidationKeyContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } - }, - "description": "User registration delegation settings properties." + } } - } -} \ No newline at end of file + }, + "definitions": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimprivatelink.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimprivatelink.json new file mode 100644 index 00000000..20af0bab --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimprivatelink.json @@ -0,0 +1,335 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Private Endpoint Connection in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnection_ListByService", + "description": "Lists all private endpoint connections of the API Management service instance.", + "x-ms-examples": { + "ApiManagementListPrivateEndpointConnections": { + "$ref": "./examples/ApiManagementListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnection_GetByName", + "description": "Gets the details of the Private Endpoint Connection specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetPrivateEndpointConnection": { + "$ref": "./examples/ApiManagementGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnection_CreateOrUpdate", + "description": "Creates a new Private Endpoint Connection or updates an existing one.", + "x-ms-examples": { + "ApiManagementApproveOrRejectPrivateEndpointConnection": { + "$ref": "./examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "privateEndpointConnectionRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/PrivateEndpointConnectionRequest" + } + } + ], + "responses": { + "202": { + "description": "Request to approve or reject private endpoint connection. Location header contains the URL where the status of the long running operation can be checked." + }, + "200": { + "description": "Private Endpoint Connection Request was completed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnection_Delete", + "description": "Deletes the specified Private Endpoint Connection.", + "x-ms-examples": { + "ApiManagementDeletePrivateEndpointConnection": { + "$ref": "./examples/ApiManagementDeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Private Endpoint Connection was successfully deleted." + }, + "202": { + "description": "Request to delete API was accepted. Location header contains the URL where the status of the long running operation can be checked." + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets the private link resources", + "operationId": "PrivateEndpointConnection_ListPrivateLinkResources", + "x-ms-examples": { + "ApiManagementListPrivateLinkGroupResources": { + "$ref": "./examples/ApiManagementListPrivateLinkGroupResources.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources/{privateLinkSubResourceName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets the private link resources", + "operationId": "PrivateEndpointConnection_GetPrivateLinkResource", + "x-ms-examples": { + "ApiManagementGetPrivateLinkGroupResource": { + "$ref": "./examples/ApiManagementGetPrivateLinkGroupResource.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "privateLinkSubResourceName", + "in": "path", + "description": "Name of the private link resource.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimproducts.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimproducts.json index c4945c50..fd6076a6 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimproducts.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimproducts.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on Product entity associated with your Azure API Management deployment. The Product entity represents a product in API Management. Products include one or more APIs and their associated terms of use. Once a product is published, developers can subscribe to the product and begin to use the product’s APIs.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products": { "get": { "tags": [ - "Products" + "Product" ], "operationId": "Product_ListByService", "description": "Lists a collection of products in the specified service instance.", @@ -58,7 +58,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -73,6 +73,13 @@ "type": "boolean", "description": "When set to true, the response contains an array of groups that have visibility to the product. The default is false." }, + { + "name": "tags", + "in": "query", + "required": false, + "type": "string", + "description": "Products which are part of a specific tag." + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -84,7 +91,7 @@ "200": { "description": "A Collection of the Product entities for the specified API Management service instance.", "schema": { - "$ref": "#/definitions/ProductCollection" + "$ref": "./definitions.json#/definitions/ProductCollection" } }, "default": { @@ -97,13 +104,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ProductContract" + "x-ms-odata": "./definitions.json#/definitions/ProductContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}": { "head": { "tags": [ - "Products" + "Product" ], "operationId": "Product_GetEntityTag", "description": "Gets the entity state (Etag) version of the product specified by its identifier.", @@ -120,7 +127,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -149,7 +156,7 @@ }, "get": { "tags": [ - "Products" + "Product" ], "operationId": "Product_Get", "description": "Gets the details of the product specified by its identifier.", @@ -166,7 +173,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -179,7 +186,7 @@ "200": { "description": "The response body contains the specified Product entity.", "schema": { - "$ref": "#/definitions/ProductContract" + "$ref": "./definitions.json#/definitions/ProductContract" }, "headers": { "ETag": { @@ -198,13 +205,13 @@ }, "put": { "tags": [ - "Products" + "Product" ], "operationId": "Product_CreateOrUpdate", "description": "Creates or Updates a product.", "x-ms-examples": { - "ApiManagementCreateProductBasic": { - "$ref": "./examples/ApiManagementCreateProductBasic.json" + "ApiManagementCreateProduct": { + "$ref": "./examples/ApiManagementCreateProduct.json" } }, "parameters": [ @@ -215,14 +222,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ProductContract" + "$ref": "./definitions.json#/definitions/ProductContract" }, "description": "Create or update parameters." }, @@ -240,13 +247,25 @@ "201": { "description": "Product was successfully created.", "schema": { - "$ref": "#/definitions/ProductContract" + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { "description": "Product was successfully updated.", "schema": { - "$ref": "#/definitions/ProductContract" + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -259,13 +278,13 @@ }, "patch": { "tags": [ - "Products" + "Product" ], "operationId": "Product_Update", - "description": "Update product.", + "description": "Update existing product details.", "x-ms-examples": { - "ApiManagementUpdateProductBasic": { - "$ref": "./examples/ApiManagementUpdateProductBasic.json" + "ApiManagementUpdateProduct": { + "$ref": "./examples/ApiManagementUpdateProduct.json" } }, "parameters": [ @@ -276,14 +295,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ProductUpdateParameters" + "$ref": "./definitions.json#/definitions/ProductUpdateParameters" }, "description": "Update parameters." }, @@ -298,8 +317,17 @@ } ], "responses": { - "204": { - "description": "No Content in case of Update Successfull." + "200": { + "description": "Product was successfully updated.", + "schema": { + "$ref": "./definitions.json#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -311,7 +339,7 @@ }, "delete": { "tags": [ - "Products" + "Product" ], "operationId": "Product_Delete", "description": "Delete product.", @@ -328,7 +356,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" }, { "name": "deleteSubscriptions", @@ -337,9 +368,6 @@ "type": "boolean", "description": "Delete existing subscriptions associated with the product or not." }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -349,10 +377,10 @@ ], "responses": { "200": { - "description": "The product was successfully deleted." + "description": "Product was successfully removed." }, "204": { - "description": "The product was successfully deleted." + "description": "Product was successfully removed by previous request or does not exist." }, "default": { "description": "Error response describing why the operation failed.", @@ -366,7 +394,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis": { "get": { "tags": [ - "ProductApis" + "ProductApi" ], "operationId": "ProductApi_ListByProduct", "description": "Lists a collection of the APIs associated with a product.", @@ -383,14 +411,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -409,7 +437,7 @@ "200": { "description": "The response body contains a collection of Api entities in the product.", "schema": { - "$ref": "./apimapis.json#/definitions/ApiCollection" + "$ref": "./definitions.json#/definitions/ApiCollection" } }, "default": { @@ -422,13 +450,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "./apimapis.json#/definitions/ApiContract" + "x-ms-odata": "./definitions.json#/definitions/ApiContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}": { "head": { "tags": [ - "ProductApis" + "ProductApi" ], "operationId": "ProductApi_CheckEntityExists", "description": "Checks that API entity specified by identifier is associated with the Product entity.", @@ -445,10 +473,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { - "$ref": "./apimapis.json#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -461,9 +489,6 @@ "204": { "description": "Entity exists" }, - "404": { - "description": "API is not associated with the product." - }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -474,7 +499,7 @@ }, "put": { "tags": [ - "ProductApis" + "ProductApi" ], "operationId": "ProductApi_CreateOrUpdate", "description": "Adds an API to the specified product.", @@ -491,10 +516,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { - "$ref": "./apimapis.json#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -507,13 +532,13 @@ "201": { "description": "The API was successfully added to the product.", "schema": { - "$ref": "./apimapis.json#/definitions/ApiContract" + "$ref": "./definitions.json#/definitions/ApiContract" } }, "200": { "description": "The specified API is already added to the product.", "schema": { - "$ref": "./apimapis.json#/definitions/ApiContract" + "$ref": "./definitions.json#/definitions/ApiContract" } }, "default": { @@ -526,7 +551,7 @@ }, "delete": { "tags": [ - "ProductApis" + "ProductApi" ], "operationId": "ProductApi_Delete", "description": "Deletes the specified API from the specified product.", @@ -543,10 +568,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { - "$ref": "./apimapis.json#/parameters/ApiIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -557,10 +582,10 @@ ], "responses": { "200": { - "description": "The API was successfully removed from the product." + "description": "API was successfully removed from product" }, "204": { - "description": "The API was successfully removed from the product." + "description": "API successfully removed by previous request or does not exist in product" }, "default": { "description": "Error response describing why the operation failed.", @@ -574,7 +599,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups": { "get": { "tags": [ - "ProductGroups" + "ProductGroup" ], "operationId": "ProductGroup_ListByProduct", "description": "Lists the collection of developer groups associated with the specified product.", @@ -591,14 +616,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| type | eq, ne | N/A |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | |
| displayName | filter | eq, ne | |
| description | filter | eq, ne | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -617,7 +642,7 @@ "200": { "description": "Lists a collection of Group entities.", "schema": { - "$ref": "./apimgroups.json#/definitions/GroupCollection" + "$ref": "./definitions.json#/definitions/GroupCollection" } }, "default": { @@ -630,13 +655,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "./apimgroups.json#/definitions/GroupContract" + "x-ms-odata": "./definitions.json#/definitions/GroupContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}": { "head": { "tags": [ - "ProductGroups" + "ProductGroup" ], "operationId": "ProductGroup_CheckEntityExists", "description": "Checks that Group entity specified by identifier is associated with the Product entity.", @@ -653,10 +678,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { - "$ref": "./apimgroups.json#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -669,9 +694,6 @@ "204": { "description": "The Group is associated with the Product." }, - "404": { - "description": "The Group entity is not associated with the Product." - }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -682,7 +704,7 @@ }, "put": { "tags": [ - "ProductGroups" + "ProductGroup" ], "operationId": "ProductGroup_CreateOrUpdate", "description": "Adds the association between the specified developer group with the specified product.", @@ -699,10 +721,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { - "$ref": "./apimgroups.json#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -715,13 +737,13 @@ "201": { "description": "The group was successfully associated with the product.", "schema": { - "$ref": "./apimgroups.json#/definitions/GroupContract" + "$ref": "./definitions.json#/definitions/GroupContract" } }, "200": { "description": "The specified group is already associated with the product.", "schema": { - "$ref": "./apimgroups.json#/definitions/GroupContract" + "$ref": "./definitions.json#/definitions/GroupContract" } }, "default": { @@ -734,7 +756,7 @@ }, "delete": { "tags": [ - "ProductGroups" + "ProductGroup" ], "operationId": "ProductGroup_Delete", "description": "Deletes the association between the specified group and product.", @@ -751,10 +773,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { - "$ref": "./apimgroups.json#/parameters/GroupIdParameter" + "$ref": "./apimanagement.json#/parameters/GroupIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -782,7 +804,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions": { "get": { "tags": [ - "ProductSubscriptions" + "ProductSubscription" ], "operationId": "ProductSubscriptions_List", "description": "Lists the collection of subscriptions to the specified product.", @@ -799,14 +821,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|--------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -825,7 +847,7 @@ "200": { "description": "Lists a collection of subscription entities.", "schema": { - "$ref": "./apimsubscriptions.json#/definitions/SubscriptionCollection" + "$ref": "./definitions.json#/definitions/SubscriptionCollection" } }, "default": { @@ -838,7 +860,7 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "./apimsubscriptions.json#/definitions/SubscriptionContract" + "x-ms-odata": "./definitions.json#/definitions/SubscriptionContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies": { @@ -849,8 +871,8 @@ "operationId": "ProductPolicy_ListByProduct", "description": "Get the policy configuration at the Product level.", "x-ms-examples": { - "ApiManagementListProductPolicy": { - "$ref": "./examples/ApiManagementListProductPolicy.json" + "ApiManagementListProductPolicies": { + "$ref": "./examples/ApiManagementListProductPolicies.json" } }, "parameters": [ @@ -861,26 +883,20 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Product Policy information.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyCollection" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } + "$ref": "./definitions.json#/definitions/PolicyCollection" } }, "default": { @@ -912,16 +928,16 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -961,23 +977,26 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" }, { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Product Policy information.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "./definitions.json#/definitions/PolicyContract" }, "headers": { "ETag": { @@ -1013,7 +1032,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" @@ -1024,10 +1043,10 @@ { "name": "parameters", "in": "body", + "required": true, "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "./definitions.json#/definitions/PolicyContract" }, - "required": true, "description": "The policy contents to apply." }, { @@ -1041,13 +1060,25 @@ "201": { "description": "Product policy configuration was successfully created.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { "description": "Product policy configuration of the tenant was successfully updated.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "./definitions.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -1077,7 +1108,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ProductIdParameter" + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" }, { "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" @@ -1107,137 +1138,271 @@ } } } - } - }, - "definitions": { - "ProductCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProductContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Products list representation." - }, - "ProductContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ProductContractProperties", - "description": "Product entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Product details." }, - "ProductContractProperties": { - "properties": { - "displayName": { - "type": "string", - "description": "Product name.", - "minLength": 1, - "maxLength": 300 - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProductEntityBaseParameters" - } - ], - "required": [ - "displayName" - ], - "description": "Product profile." - }, - "ProductEntityBaseParameters": { - "properties": { - "description": { - "type": "string", - "description": "Product description. May include HTML formatting tags.", - "minLength": 1, - "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." + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags": { + "get": { + "tags": [ + "ProductTag" + ], + "operationId": "Tag_ListByProduct", + "description": "Lists all Tags associated with the Product.", + "x-ms-examples": { + "ApiManagementListProductTags": { + "$ref": "./examples/ApiManagementListProductTags.json" + } }, - "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" + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Product entity.", + "schema": { + "$ref": "./definitions.json#/definitions/TagCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } }, - "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" + "x-ms-pageable": { + "nextLinkName": "nextLink" }, - "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." + "x-ms-odata": "./definitions.json#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}": { + "head": { + "tags": [ + "ProductTag" + ], + "operationId": "Tag_GetEntityStateByProduct", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadProductTag": { + "$ref": "./examples/ApiManagementHeadProductTag.json" + } }, - "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 + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } } }, - "description": "Product Entity Base Parameters" - }, - "ProductUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ProductUpdateProperties", - "description": "Product entity Update contract properties." + "get": { + "tags": [ + "ProductTag" + ], + "operationId": "Tag_GetByProduct", + "description": "Get tag associated with the Product.", + "x-ms-examples": { + "ApiManagementGetProductTag": { + "$ref": "./examples/ApiManagementGetProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } }, - "description": "Product Update parameters." - }, - "ProductUpdateProperties": { - "properties": { - "displayName": { - "type": "string", - "description": "Product name.", - "maxLength": 300, - "minLength": 1 + "put": { + "tags": [ + "ProductTag" + ], + "operationId": "Tag_AssignToProduct", + "description": "Assign tag to the Product.", + "x-ms-examples": { + "ApiManagementCreateProductTag": { + "$ref": "./examples/ApiManagementCreateProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Product.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "200": { + "description": "Tag is already assigned to the Product.", + "schema": { + "$ref": "./definitions.json#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } }, - "allOf": [ - { - "$ref": "#/definitions/ProductEntityBaseParameters" + "delete": { + "tags": [ + "ProductTag" + ], + "operationId": "Tag_DetachFromProduct", + "description": "Detach the tag from the Product.", + "x-ms-examples": { + "ApiManagementDeleteProductTag": { + "$ref": "./examples/ApiManagementDeleteProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully detached the tag from the Product." + }, + "204": { + "description": "Successfully detached the tag from the Product." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } } - ], - "description": "Parameters supplied to the Update Product operation." + } } }, - "parameters": { - "ProductIdParameter": { - "name": "productId", - "in": "path", - "required": true, - "type": "string", - "description": "Product identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimproductsByTags.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimproductsByTags.json new file mode 100644 index 00000000..9de64ae8 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimproductsByTags.json @@ -0,0 +1,106 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations to retrieve Products by Tags in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/productsByTags": { + "get": { + "tags": [ + "ProductsByTag" + ], + "operationId": "Product_ListByTags", + "description": "Lists a collection of products associated with tags.", + "x-ms-examples": { + "ApiManagementListProductsByTags": { + "$ref": "./examples/ApiManagementListProductsByTags.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "includeNotTaggedProducts", + "in": "query", + "required": false, + "type": "boolean", + "description": "Include not tagged Products." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TagResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/TagResourceContract" + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimquotas.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimquotas.json index 1e41a13b..7288a201 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimquotas.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimquotas.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on Quota entity associated with your Azure API Management deployment. To configure call rate limit and quota policies refer to [how to configure call rate limit and quota](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies).", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -46,14 +46,11 @@ "description": "Document describing how to configure the quota policies." }, "x-ms-examples": { - "ApiManagementGetQuotaCounteryKeys": { - "$ref": "./examples/ApiManagementGetQuotaCounteryKeys.json" + "ApiManagementGetQuotaCounterKeys": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeys.json" } }, "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" }, @@ -61,17 +58,20 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/QuotaCounterKeyParameter" + "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Lists a collection of the quota counter values.", "schema": { - "$ref": "#/definitions/QuotaCounterCollection" + "$ref": "./definitions.json#/definitions/QuotaCounterCollection" } }, "default": { @@ -101,14 +101,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/QuotaCounterKeyParameter" + "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QuotaCounterValueContractProperties" + "$ref": "./definitions.json#/definitions/QuotaCounterValueUpdateContract" }, "description": "The value of the quota counter to be applied to all quota counter periods." }, @@ -120,8 +120,11 @@ } ], "responses": { - "204": { - "description": "Quota counter period was successfully updated." + "200": { + "description": "Updated Quota Counter Values.", + "schema": { + "$ref": "./definitions.json#/definitions/QuotaCounterCollection" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -144,14 +147,11 @@ "description": "Document describing how to configure the quota policies." }, "x-ms-examples": { - "ApiManagementGetQuotaCounteryKeysByQuotaPeriod": { - "$ref": "./examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json" + "ApiManagementGetQuotaCounterKeysByQuotaPeriod": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json" } }, "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" }, @@ -159,20 +159,23 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/QuotaCounterKeyParameter" + "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" }, { - "$ref": "#/parameters/QuotaPeriodKeyParameter" + "$ref": "./apimanagement.json#/parameters/QuotaPeriodKeyParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The response body contains the Quota counter details for the specified period.", "schema": { - "$ref": "#/definitions/QuotaCounterContract" + "$ref": "./definitions.json#/definitions/QuotaCounterContract" } }, "default": { @@ -202,17 +205,17 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/QuotaCounterKeyParameter" + "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" }, { - "$ref": "#/parameters/QuotaPeriodKeyParameter" + "$ref": "./apimanagement.json#/parameters/QuotaPeriodKeyParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QuotaCounterValueContractProperties" + "$ref": "./definitions.json#/definitions/QuotaCounterValueUpdateContract" }, "description": "The value of the Quota counter to be applied on the specified period." }, @@ -224,8 +227,11 @@ } ], "responses": { - "204": { - "description": "The quota counter value was successfully updated." + "200": { + "description": "The response body contains the Quota counter details for the specified period.", + "schema": { + "$ref": "./definitions.json#/definitions/QuotaCounterContract" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -237,105 +243,6 @@ } } }, - "definitions": { - "QuotaCounterCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/QuotaCounterContract" - }, - "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": { - "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": { - "properties": { - "value": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/QuotaCounterValueContractProperties", - "description": "Quota counter Value Properties." - } - }, - "description": "Quota counter value details." - }, - "QuotaCounterValueContractProperties": { - "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." - } - }, - "parameters": { - "QuotaCounterKeyParameter": { - "name": "quotaCounterKey", - "in": "path", - "required": true, - "type": "string", - "description": "Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key=\"boo\" in the policy, then it’s accessible by \"boo\" counter key. But if it’s defined as counter-key=\"@(\"b\"+\"a\")\" then it will be accessible by \"ba\" key", - "x-ms-parameter-location": "method" - }, - "QuotaPeriodKeyParameter": { - "name": "quotaPeriodKey", - "in": "path", - "required": true, - "type": "string", - "description": "Quota period key identifier.", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimregions.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimregions.json new file mode 100644 index 00000000..e4455b63 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimregions.json @@ -0,0 +1,85 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions": { + "get": { + "tags": [ + "Region" + ], + "operationId": "Region_ListByService", + "description": "Lists all azure regions in which the service exists.", + "x-ms-examples": { + "ApiManagementListRegions": { + "$ref": "./examples/ApiManagementListRegions.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists of Regions in which the service is deployed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/RegionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimreports.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimreports.json index da029fd6..a76658ee 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimreports.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimreports.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs to get the analytics reports associated with your Azure API Management deployment.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -66,6 +66,13 @@ { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -77,14 +84,20 @@ "200": { "description": "Lists a collection of Report record.", "schema": { - "$ref": "#/definitions/ReportCollection" + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ReportRecordContract" + "x-ms-odata": "./definitions.json#/definitions/ReportRecordContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser": { @@ -111,7 +124,7 @@ "in": "query", "required": true, "type": "string", - "description": "The filter to apply on the operation." + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| userId | select, filter | eq | |
| apiRegion | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -119,6 +132,13 @@ { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -130,14 +150,20 @@ "200": { "description": "Lists a collection of Report record.", "schema": { - "$ref": "#/definitions/ReportCollection" + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ReportRecordContract" + "x-ms-odata": "./definitions.json#/definitions/ReportRecordContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation": { @@ -164,7 +190,7 @@ "in": "query", "required": true, "type": "string", - "description": "The filter to apply on the operation." + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -172,6 +198,13 @@ { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -183,14 +216,20 @@ "200": { "description": "Lists a collection of Report record.", "schema": { - "$ref": "#/definitions/ReportCollection" + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ReportRecordContract" + "x-ms-odata": "./definitions.json#/definitions/ReportRecordContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct": { @@ -217,7 +256,7 @@ "in": "query", "required": true, "type": "string", - "description": "The filter to apply on the operation." + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -225,6 +264,13 @@ { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -236,14 +282,20 @@ "200": { "description": "Lists a collection of Report record.", "schema": { - "$ref": "#/definitions/ReportCollection" + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ReportRecordContract" + "x-ms-odata": "./definitions.json#/definitions/ReportRecordContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo": { @@ -252,7 +304,7 @@ "Reports" ], "operationId": "Reports_ListByGeo", - "description": "Lists report records by GeoGraphy.", + "description": "Lists report records by geography.", "x-ms-examples": { "ApiManagementGetReportsByGeo": { "$ref": "./examples/ApiManagementGetReportsByGeo.json" @@ -268,9 +320,9 @@ { "name": "$filter", "in": "query", - "required": false, + "required": true, "type": "string", - "description": "The filter to apply on the operation." + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| country | select | | |
| region | select | | |
| zip | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -289,14 +341,20 @@ "200": { "description": "Lists a collection of Report record.", "schema": { - "$ref": "#/definitions/ReportCollection" + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ReportRecordContract" + "x-ms-odata": "./definitions.json#/definitions/ReportRecordContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription": { @@ -321,9 +379,9 @@ { "name": "$filter", "in": "query", - "required": false, + "required": true, "type": "string", - "description": "The filter to apply on the operation." + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | select, filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -331,6 +389,13 @@ { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -342,14 +407,20 @@ "200": { "description": "Lists a collection of Report record.", "schema": { - "$ref": "#/definitions/ReportCollection" + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ReportRecordContract" + "x-ms-odata": "./definitions.json#/definitions/ReportRecordContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime": { @@ -374,9 +445,9 @@ { "name": "$filter", "in": "query", - "required": false, + "required": true, "type": "string", - "description": "The filter to apply on the operation." + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter, select | ge, le | |
| interval | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -384,13 +455,20 @@ { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OData order by query option." + }, { "name": "interval", "in": "query", "required": true, "type": "string", "format": "duration", - "description": "By time interval. 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).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))" + "description": "By time interval. 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).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))." }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -403,14 +481,20 @@ "200": { "description": "Lists a collection of Report record.", "schema": { - "$ref": "#/definitions/ReportCollection" + "$ref": "./definitions.json#/definitions/ReportCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ReportRecordContract" + "x-ms-odata": "./definitions.json#/definitions/ReportRecordContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest": { @@ -437,7 +521,7 @@ "in": "query", "required": true, "type": "string", - "description": "The filter to apply on the operation." + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| productId | filter | eq | |
| userId | filter | eq | |
| apiRegion | filter | eq | |
| subscriptionId | filter | eq | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -456,267 +540,23 @@ "200": { "description": "Lists a collection of Report record.", "schema": { - "$ref": "#/definitions/RequestReportCollection" + "$ref": "./definitions.json#/definitions/RequestReportCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, - "x-ms-odata": "#/definitions/RequestReportRecordContract" + "x-ms-odata": "./definitions.json#/definitions/RequestReportRecordContract" } } }, - "definitions": { - "ReportCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ReportRecordContract" - }, - "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": { - "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 agregation 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 succesful 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.Unauthorize and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" - }, - "callCountFailed": { - "type": "integer", - "format": "int32", - "description": "Number of calls failed due to proxy 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." - }, - "RequestReportCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RequestReportRecordContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - } - }, - "description": "Paged Report records list representation." - }, - "RequestReportRecordContract": { - "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 fullfilled 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." - } - }, + "definitions": {}, "parameters": {} -} \ No newline at end of file +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimschema.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimschema.json new file mode 100644 index 00000000..d071e9d0 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimschema.json @@ -0,0 +1,331 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Schema entity in Azure API Management deployment.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas": { + "get": { + "tags": [ + "Schema" + ], + "operationId": "GlobalSchema_ListByService", + "description": "Lists a collection of schemas registered with service instance.", + "x-ms-examples": { + "ApiManagementListSchemas": { + "$ref": "./examples/ApiManagementListGlobalSchemas.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Schema entities.", + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/GlobalSchemaContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}": { + "head": { + "tags": [ + "Schema" + ], + "operationId": "GlobalSchema_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Schema specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApi": { + "$ref": "./examples/ApiManagementHeadGlobalSchema.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Schema entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Schema" + ], + "operationId": "GlobalSchema_Get", + "description": "Gets the details of the Schema specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetSchema1": { + "$ref": "./examples/ApiManagementGetGlobalSchema1.json" + }, + "ApiManagementGetSchema2": { + "$ref": "./examples/ApiManagementGetGlobalSchema2.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Schema entity.", + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Schema" + ], + "operationId": "GlobalSchema_CreateOrUpdate", + "description": "Creates new or updates existing specified Schema of the API Management service instance.", + "x-ms-examples": { + "ApiManagementCreateSchema1": { + "$ref": "./examples/ApiManagementCreateGlobalSchema1.json" + }, + "ApiManagementCreateSchema2": { + "$ref": "./examples/ApiManagementCreateGlobalSchema2.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new Schema was successfully added.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + } + }, + "200": { + "description": "The Schema details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/GlobalSchemaContract" + } + }, + "202": { + "description": "Accepted the change when updating the service." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "Schema" + ], + "operationId": "GlobalSchema_Delete", + "description": "Deletes specific Schema.", + "x-ms-examples": { + "ApiManagementDeleteSchema": { + "$ref": "./examples/ApiManagementDeleteGlobalSchema.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Schema was successfully deleted." + }, + "204": { + "description": "The Schema was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimsettings.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimsettings.json new file mode 100644 index 00000000..b4a9813d --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimsettings.json @@ -0,0 +1,144 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on settings entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings": { + "get": { + "tags": [ + "TenantSettings" + ], + "operationId": "TenantSettings_ListByService", + "description": "Public settings.", + "x-ms-examples": { + "ApiManagementListTenantSettings": { + "$ref": "./examples/ApiManagementListTenantSettings.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Not used" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TenantSettings entities.", + "schema": { + "$ref": "./definitions.json#/definitions/TenantSettingsCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/TenantSettingsContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings/{settingsType}": { + "get": { + "tags": [ + "TenantSettings" + ], + "operationId": "TenantSettings_Get", + "description": "Get tenant settings.", + "x-ms-examples": { + "ApiManagementGetTenantSettings": { + "$ref": "./examples/ApiManagementGetTenantSettings.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SettingsParameter" + } + ], + "responses": { + "200": { + "description": "Tenant Settings.", + "schema": { + "$ref": "./definitions.json#/definitions/TenantSettingsContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimskus.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimskus.json new file mode 100644 index 00000000..d13d5450 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimskus.json @@ -0,0 +1,391 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "SKUs available for Microsoft.ApiManagement", + "version": "2021-08-01" + }, + "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": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/skus": { + "get": { + "tags": [ + "Skus" + ], + "operationId": "ApiManagementSkus_List", + "description": "Gets the list of Microsoft.ApiManagement SKUs available for your Subscription.", + "x-ms-examples": { + "Lists all available Resource SKUs": { + "$ref": "./examples/ApiManagementListSku.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApiManagementSkusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ApiManagementSkuCapacity": { + "properties": { + "minimum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The maximum capacity that can be set." + }, + "default": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The default capacity." + }, + "scaleType": { + "type": "string", + "readOnly": true, + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "x-ms-enum": { + "name": "ApiManagementSkuCapacityScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ApiManagementSkuCosts": { + "properties": { + "meterID": { + "type": "string", + "readOnly": true, + "description": "Used for querying price from commerce." + }, + "quantity": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The multiplier is needed to extend the base metered cost." + }, + "extendedUnit": { + "type": "string", + "readOnly": true, + "description": "An invariant to show the extended unit." + } + }, + "description": "Describes metadata for retrieving price info." + }, + "ApiManagementSkuCapabilities": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "An invariant to describe the feature." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "An invariant if the feature is measured by quantity." + } + }, + "description": "Describes The SKU capabilities object." + }, + "ApiManagementSkuZoneDetails": { + "properties": { + "name": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of zones that the SKU is available in with the specified capabilities." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiManagementSkuCapabilities" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of capabilities that are available for the SKU in the specified list of zones." + } + }, + "description": "Describes The zonal capabilities of a SKU." + }, + "ApiManagementSkuRestrictions": { + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of restrictions.", + "enum": [ + "Location", + "Zone" + ], + "x-ms-enum": { + "name": "ApiManagementSkuRestrictionsType", + "modelAsString": false + } + }, + "values": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "restrictionInfo": { + "$ref": "#/definitions/ApiManagementSkuRestrictionInfo", + "readOnly": true, + "description": "The information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "type": "string", + "readOnly": true, + "description": "The reason for restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ApiManagementSkuRestrictionsReasonCode", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ApiManagementSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of SKU." + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic**" + }, + "size": { + "readOnly": true, + "type": "string", + "description": "The Size of the SKU." + }, + "family": { + "readOnly": true, + "type": "string", + "description": "The Family of this particular SKU." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "The Kind of resources that are supported in this SKU." + }, + "capacity": { + "$ref": "#/definitions/ApiManagementSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + }, + "locations": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available." + }, + "locationInfo": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiManagementSkuLocationInfo" + }, + "x-ms-identifiers": [ + "location" + ], + "description": "A list of locations and availability zones in those locations where the SKU is available." + }, + "apiVersions": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The api versions that support this SKU." + }, + "costs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiManagementSkuCosts" + }, + "x-ms-identifiers": [ + "meterID" + ], + "description": "Metadata for retrieving price info." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiManagementSkuCapabilities" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A name value pair to describe the capability." + }, + "restrictions": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiManagementSkuRestrictions" + }, + "x-ms-identifiers": [], + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "description": "Describes an available ApiManagement SKU." + }, + "ApiManagementSkuLocationInfo": { + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Location of the SKU" + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is supported." + }, + "zoneDetails": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ApiManagementSkuZoneDetails" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Details of capabilities available to a SKU in specific zones." + } + } + }, + "ApiManagementSkuRestrictionInfo": { + "properties": { + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Locations where the SKU is restricted" + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is restricted." + } + } + }, + "ApiManagementSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiManagementSku" + }, + "x-ms-identifiers": [ + "name", + "resourceType" + ], + "description": "The list of skus available for the subscription." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus" + } + }, + "required": [ + "value" + ], + "description": "The List Resource Skus operation response." + } + }, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimsubscriptions.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimsubscriptions.json index 8f60defe..97f4c60b 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimsubscriptions.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimsubscriptions.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on Subscription entity associated with your Azure API Management deployment. The Subscription entity represents the association between a user and a product in API Management. Products contain one or more APIs, and once a product is published, developers can subscribe to the product and begin to use the product’s APIs.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions": { "get": { "tags": [ - "Subscriptions" + "Subscription" ], "operationId": "Subscription_List", "description": "Lists all subscriptions of the API Management service instance.", @@ -58,7 +58,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|--------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -77,7 +77,7 @@ "200": { "description": "A collection of the Subscription entities for the specified API Management service instance.", "schema": { - "$ref": "#/definitions/SubscriptionCollection" + "$ref": "./definitions.json#/definitions/SubscriptionCollection" } }, "default": { @@ -90,13 +90,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/SubscriptionContract" + "x-ms-odata": "./definitions.json#/definitions/SubscriptionContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}": { "head": { "tags": [ - "Subscriptions" + "Subscription" ], "operationId": "Subscription_GetEntityTag", "description": "Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.", @@ -113,7 +113,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/SubscriptionEntityIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -142,7 +142,7 @@ }, "get": { "tags": [ - "Subscriptions" + "Subscription" ], "operationId": "Subscription_Get", "description": "Gets the specified Subscription entity.", @@ -159,7 +159,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/SubscriptionEntityIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -172,7 +172,7 @@ "200": { "description": "The response body contains the specified Subscription entity.", "schema": { - "$ref": "#/definitions/SubscriptionContract" + "$ref": "./definitions.json#/definitions/SubscriptionContract" }, "headers": { "ETag": { @@ -191,7 +191,7 @@ }, "put": { "tags": [ - "Subscriptions" + "Subscription" ], "operationId": "Subscription_CreateOrUpdate", "description": "Creates or updates the subscription of specified user to the specified product.", @@ -208,19 +208,19 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/SubscriptionEntityIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SubscriptionCreateParameters" + "$ref": "./definitions.json#/definitions/SubscriptionCreateParameters" }, "description": "Create parameters." }, { - "$ref": "#/parameters/NotifySubscriptionStateChangeParameter" + "$ref": "./apimanagement.json#/parameters/NotifySubscriptionStateChangeParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" @@ -230,19 +230,34 @@ }, { "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AppTypeParameter" } ], "responses": { "201": { "description": "The user was successfully subscribed to the product.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/SubscriptionContract" + "$ref": "./definitions.json#/definitions/SubscriptionContract" } }, "200": { "description": "The user already subscribed to the product.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/SubscriptionContract" + "$ref": "./definitions.json#/definitions/SubscriptionContract" } }, "default": { @@ -255,10 +270,10 @@ }, "patch": { "tags": [ - "Subscriptions" + "Subscription" ], "operationId": "Subscription_Update", - "description": "Updates the details of a subscription specificied by its identifier.", + "description": "Updates the details of a subscription specified by its identifier.", "x-ms-examples": { "ApiManagementUpdateSubscription": { "$ref": "./examples/ApiManagementUpdateSubscription.json" @@ -272,19 +287,19 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/SubscriptionEntityIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SubscriptionUpdateParameters" + "$ref": "./definitions.json#/definitions/SubscriptionUpdateParameters" }, "description": "Update parameters." }, { - "$ref": "#/parameters/NotifySubscriptionStateChangeParameter" + "$ref": "./apimanagement.json#/parameters/NotifySubscriptionStateChangeParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -294,11 +309,23 @@ }, { "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AppTypeParameter" } ], "responses": { - "204": { - "description": "The subscription details were successfully updated." + "200": { + "description": "The subscription details were successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -310,7 +337,7 @@ }, "delete": { "tags": [ - "Subscriptions" + "Subscription" ], "operationId": "Subscription_Delete", "description": "Deletes the specified subscription.", @@ -327,7 +354,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/SubscriptionEntityIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -358,13 +385,13 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regeneratePrimaryKey": { "post": { "tags": [ - "Subscriptions" + "Subscription" ], "operationId": "Subscription_RegeneratePrimaryKey", "description": "Regenerates primary key of existing subscription of the API Management service instance.", "x-ms-examples": { - "ApiManagementSubscriptionRegenerateKey": { - "$ref": "./examples/ApiManagementSubscriptionRegenerateKey.json" + "ApiManagementSubscriptionRegeneratePrimaryKey": { + "$ref": "./examples/ApiManagementSubscriptionRegeneratePrimaryKey.json" } }, "parameters": [ @@ -375,7 +402,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/SubscriptionEntityIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -400,13 +427,13 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey": { "post": { "tags": [ - "Subscriptions" + "Subscription" ], "operationId": "Subscription_RegenerateSecondaryKey", "description": "Regenerates secondary key of existing subscription of the API Management service instance.", "x-ms-examples": { - "ApiManagementSubscriptionRegenerateKey": { - "$ref": "./examples/ApiManagementSubscriptionRegenerateKey.json" + "ApiManagementSubscriptionRegenerateSecondaryKey": { + "$ref": "./examples/ApiManagementSubscriptionRegenerateSecondaryKey.json" } }, "parameters": [ @@ -417,7 +444,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/SubscriptionEntityIdParameter" + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -438,269 +465,59 @@ } } } - } - }, - "definitions": { - "SubscriptionCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SubscriptionContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Subscriptions list representation." - }, - "SubscriptionContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SubscriptionContractProperties", - "description": "Subscription contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Subscription details." }, - "SubscriptionContractProperties": { - "properties": { - "userId": { - "type": "string", - "description": "The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier." - }, - "productId": { - "type": "string", - "description": "The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier." - }, - "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 + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/listSecrets": { + "post": { + "tags": [ + "Subscription" + ], + "operationId": "Subscription_ListSecrets", + "description": "Gets the specified Subscription keys.", + "x-ms-examples": { + "ApiManagementSubscriptionListSecrets": { + "$ref": "./examples/ApiManagementSubscriptionListSecrets.json" } }, - "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": { - "type": "string", - "description": "Subscription primary key.", - "minLength": 1, - "maxLength": 256 - }, - "secondaryKey": { - "type": "string", - "description": "Subscription secondary key.", - "minLength": 1, - "maxLength": 256 - }, - "stateComment": { - "type": "string", - "description": "Optional subscription comment added by an administrator." - } - }, - "required": [ - "userId", - "productId", - "state", - "primaryKey", - "secondaryKey" - ], - "description": "Subscription details." - }, - "SubscriptionCreateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SubscriptionCreateParameterProperties", - "description": "Subscription contract properties." - } - }, - "description": "Subscription create details." - }, - "SubscriptionCreateParameterProperties": { - "properties": { - "userId": { - "type": "string", - "description": "User (user id path) for whom subscription is being created in form /users/{uid}" - }, - "productId": { - "type": "string", - "description": "Product (product id path) for which subscription is being created in form /products/{productid}" - }, - "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 + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } - } - }, - "required": [ - "userId", - "productId", - "displayName" - ], - "description": "Parameters supplied to the Create subscription operation." - }, - "SubscriptionUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SubscriptionUpdateParameterProperties", - "description": "Subscription Update contract properties." - } - }, - "description": "Subscription update details." - }, - "SubscriptionUpdateParameterProperties": { - "properties": { - "userId": { - "type": "string", - "description": "User identifier path: /users/{uid}" - }, - "productId": { - "type": "string", - "description": "Product identifier path: /products/{productId}" - }, - "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 + ], + "responses": { + "200": { + "description": "The response body contains subscription keys.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionKeysContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } - }, - "stateComment": { - "type": "string", - "description": "Comments describing subscription state change by the administrator." } - }, - "description": "Parameters supplied to the Update subscription operation." + } } }, - "parameters": { - "SubscriptionEntityIdParameter": { - "name": "sid", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - }, - "NotifySubscriptionStateChangeParameter": { - "name": "notify", - "in": "query", - "required": false, - "type": "boolean", - "description": "Notify change in Subscription State. \n - If false, do not send any email notification for change of state of subscription \n - If true, send email notification of change of state of subscription ", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtagresources.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtagresources.json index b659290e..f0f0db56 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtagresources.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtagresources.json @@ -2,14 +2,16 @@ "swagger": "2.0", "info": { "title": "ApiManagementClient", - "description": "Use these REST APIs for queuering APIs. Operations and Products by tags in your Azure API Management deployment.", - "version": "2018-01-01" + "description": "Use these REST APIs for querying APIs. Operations and Products by tags in your Azure API Management deployment.", + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ "https" ], - "consumes": [], + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -35,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tagResources": { "get": { "tags": [ - "TagResources" + "TagResource" ], "operationId": "TagResource_ListByService", "description": "Lists a collection of resources associated with tags.", @@ -56,7 +58,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| isCurrent | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| aid | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| isCurrent | filter | eq | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -75,196 +77,23 @@ "200": { "description": "Lists a collection of TagResource entities.", "schema": { - "$ref": "#/definitions/TagResourceCollection" + "$ref": "./definitions.json#/definitions/TagResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/TagResourceContract" + "x-ms-odata": "./definitions.json#/definitions/TagResourceContract" } } }, - "definitions": { - "TagResourceCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagResourceContract" - }, - "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": { - "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": { - "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" - }, - "ApiTagResourceContractProperties": { - "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" - ], - "x-ms-enum": { - "name": "Protocol", - "modelAsString": false - } - }, - "description": "Describes on which protocols the operations in this API can be invoked." - } - }, - "allOf": [ - { - "$ref": "./apimapis.json#/definitions/ApiEntityBaseContract" - } - ], - "description": "API contract properties for the Tag Resources." - }, - "ProductTagResourceContractProperties": { - "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": "./apimproducts.json#/definitions/ProductEntityBaseParameters" - } - ], - "required": [ - "name" - ], - "description": "Product profile." - }, - "OperationTagResourceContractProperties": { - "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." - } - }, + "definitions": {}, "parameters": {} -} \ No newline at end of file +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtags.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtags.json index 0315b8ef..3763ee62 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtags.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtags.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on Tag entity in your Azure API Management deployment. Tags can be assigned to APIs, Operations and Products.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags": { "get": { "tags": [ - "Tags" + "Tag" ], "operationId": "Tag_ListByService", "description": "Lists a collection of tags defined within a service instance.", @@ -58,7 +58,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -66,6 +66,13 @@ { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, + { + "name": "scope", + "in": "query", + "required": false, + "type": "string", + "description": "Scope like 'apis', 'products' or 'apis/{apiId}" + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -77,25 +84,31 @@ "200": { "description": "Lists a collection of Tag entities.", "schema": { - "$ref": "#/definitions/TagCollection" + "$ref": "./definitions.json#/definitions/TagCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/TagContract" + "x-ms-odata": "./definitions.json#/definitions/TagContract" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}": { "head": { "tags": [ - "Tags" + "Tag" ], "operationId": "Tag_GetEntityState", "description": "Gets the entity state version of the tag specified by its identifier.", "x-ms-examples": { - "ApiManagementGetTag": { + "ApiManagementHeadTag": { "$ref": "./examples/ApiManagementHeadTag.json" } }, @@ -107,7 +120,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/TagIdParameter" + "$ref": "./apimanagement.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -136,7 +149,7 @@ }, "get": { "tags": [ - "Tags" + "Tag" ], "operationId": "Tag_Get", "description": "Gets the details of the tag specified by its identifier.", @@ -153,7 +166,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/TagIdParameter" + "$ref": "./apimanagement.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -166,7 +179,7 @@ "200": { "description": "The response body contains the specified Tag entity.", "schema": { - "$ref": "#/definitions/TagContract" + "$ref": "./definitions.json#/definitions/TagContract" }, "headers": { "ETag": { @@ -185,7 +198,7 @@ }, "put": { "tags": [ - "Tags" + "Tag" ], "operationId": "Tag_CreateOrUpdate", "description": "Creates a tag.", @@ -202,17 +215,20 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/TagIdParameter" + "$ref": "./apimanagement.json#/parameters/TagIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TagCreateUpdateParameters" + "$ref": "./definitions.json#/definitions/TagCreateUpdateParameters" }, "description": "Create parameters." }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -222,15 +238,27 @@ ], "responses": { "201": { - "description": "Tag was created succesfully.", + "description": "Tag was created successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/TagContract" + "$ref": "./definitions.json#/definitions/TagContract" } }, "200": { "description": "Tag already exists.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/TagContract" + "$ref": "./definitions.json#/definitions/TagContract" } }, "default": { @@ -243,7 +271,7 @@ }, "patch": { "tags": [ - "Tags" + "Tag" ], "operationId": "Tag_Update", "description": "Updates the details of the tag specified by its identifier.", @@ -260,14 +288,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/TagIdParameter" + "$ref": "./apimanagement.json#/parameters/TagIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TagCreateUpdateParameters" + "$ref": "./definitions.json#/definitions/TagCreateUpdateParameters" }, "description": "Update parameters." }, @@ -281,274 +309,17 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], - "responses": { - "204": { - "description": "The tag details were successfully updated." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Tags" - ], - "operationId": "Tag_Delete", - "description": "Deletes specific tag of the API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteTag": { - "$ref": "./examples/ApiManagementDeleteTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The tag was successfully deleted." - }, - "204": { - "description": "The tag was successfully deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags": { - "get": { - "tags": [ - "ApiTags" - ], - "operationId": "Tag_ListByApi", - "description": "Lists all Tags associated with the API.", - "x-ms-examples": { - "ApiManagementGetTagsForApi": { - "$ref": "./examples/ApiManagementGetTagsForApi.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of tags associated with the Api entity.", - "schema": { - "$ref": "#/definitions/TagCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/TagContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}": { - "head": { - "tags": [ - "ApiTags" - ], - "operationId": "Tag_GetEntityStateByApi", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiTag": { - "$ref": "./examples/ApiManagementHeadApiTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], "responses": { "200": { - "description": "Empty response body, ETag header entity state version.", + "description": "The tag details were successfully updated.", "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", "type": "string" } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiTags" - ], - "operationId": "Tag_GetByApi", - "description": "Get tag associated with the API.", - "x-ms-examples": { - "ApiManagementGetApiTag": { - "$ref": "./examples/ApiManagementGetApiTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the details of the tag specified by its identifier.", - "schema": { - "$ref": "#/definitions/TagContract" }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiTags" - ], - "operationId": "Tag_AssignToApi", - "description": "Assign tag to the Api.", - "x-ms-examples": { - "ApiManagementCreateApiTag": { - "$ref": "./examples/ApiManagementCreateApiTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag was assigned to the Api.", - "schema": { - "$ref": "#/definitions/TagContract" - } - }, - "200": { - "description": "Tag is already assigned to the Api.", "schema": { - "$ref": "#/definitions/TagContract" + "$ref": "./definitions.json#/definitions/TagContract" } }, "default": { @@ -561,13 +332,13 @@ }, "delete": { "tags": [ - "ApiTags" + "Tag" ], - "operationId": "Tag_DetachFromApi", - "description": "Detach the tag from the Api.", + "operationId": "Tag_Delete", + "description": "Deletes specific tag of the API Management service instance.", "x-ms-examples": { - "ApiManagementDeleteApiTag": { - "$ref": "./examples/ApiManagementDeleteApiTag.json" + "ApiManagementDeleteTag": { + "$ref": "./examples/ApiManagementDeleteTag.json" } }, "parameters": [ @@ -578,10 +349,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" + "$ref": "./apimanagement.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -595,10 +363,10 @@ ], "responses": { "200": { - "description": "Successfully detached the tag from the Api." + "description": "Tag successfully removed" }, "204": { - "description": "Successfully detached the tag from the Api." + "description": "Tag successfully removed by previous request or does not exist" }, "default": { "description": "Error response describing why the operation failed.", @@ -608,1038 +376,8 @@ } } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions": { - "get": { - "tags": [ - "ApiTagDescriptions" - ], - "operationId": "TagDescription_ListByApi", - "description": "Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations", - "x-ms-examples": { - "ApiManagementGetTagDescriptionsForApi": { - "$ref": "./examples/ApiManagementGetTagDescriptionsForApi.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of tagDescriptions associated with the Api entity.", - "schema": { - "$ref": "#/definitions/TagDescriptionCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/TagDescriptionContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagId}": { - "head": { - "tags": [ - "ApiTagDescriptions" - ], - "operationId": "TagDescription_GetEntityState", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiTagDescription": { - "$ref": "./examples/ApiManagementHeadApiTagDescription.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiTagDescriptions" - ], - "operationId": "TagDescription_Get", - "description": "Get tag associated with the API.", - "x-ms-examples": { - "ApiManagementGetApiTagDescription": { - "$ref": "./examples/ApiManagementGetApiTagDescription.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the description of the tag specified by its identifier in scope if the Api.", - "schema": { - "$ref": "#/definitions/TagDescriptionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiTagDescriptions" - ], - "operationId": "TagDescription_CreateOrUpdate", - "description": "Create/Update tag fescription in scope of the Api.", - "x-ms-examples": { - "ApiManagementCreateApiTagDescription": { - "$ref": "./examples/ApiManagementCreateApiTagDescription.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TagDescriptionCreateParameters" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag Description was created for the Api.", - "schema": { - "$ref": "#/definitions/TagDescriptionContract" - } - }, - "200": { - "description": "Tag Description was updated for the Api.", - "schema": { - "$ref": "#/definitions/TagDescriptionContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiTagDescriptions" - ], - "operationId": "TagDescription_Delete", - "description": "Delete tag description for the Api.", - "x-ms-examples": { - "ApiManagementDeleteApiTagDescription": { - "$ref": "./examples/ApiManagementDeleteApiTagDescription.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted tag description for the Api." - }, - "204": { - "description": "Successfully deleted tag description for the Api." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags": { - "get": { - "tags": [ - "OperationTags" - ], - "operationId": "Tag_ListByOperation", - "description": "Lists all Tags associated with the Operation.", - "x-ms-examples": { - "ApiManagementGetTagsForOperation": { - "$ref": "./examples/ApiManagementGetTagsForOperation.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimapis.json#/parameters/OperationIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of tags associated with the Operation entity.", - "schema": { - "$ref": "#/definitions/TagCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/TagContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}": { - "head": { - "tags": [ - "OperationTags" - ], - "operationId": "Tag_GetEntityStateByOperation", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadOperationTag": { - "$ref": "./examples/ApiManagementHeadOperationTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimapis.json#/parameters/OperationIdParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "OperationTags" - ], - "operationId": "Tag_GetByOperation", - "description": "Get tag associated with the Operation.", - "x-ms-examples": { - "ApiManagementGetOperationTag": { - "$ref": "./examples/ApiManagementGetOperationTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimapis.json#/parameters/OperationIdParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the details of the tag specified by its identifier.", - "schema": { - "$ref": "#/definitions/TagContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "OperationTags" - ], - "operationId": "Tag_AssignToOperation", - "description": "Assign tag to the Operation.", - "x-ms-examples": { - "ApiManagementCreateOperationTag": { - "$ref": "./examples/ApiManagementCreateOperationTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimapis.json#/parameters/OperationIdParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag was assigned to the Operation.", - "schema": { - "$ref": "#/definitions/TagContract" - } - }, - "200": { - "description": "Tag is already assigned to the Operation.", - "schema": { - "$ref": "#/definitions/TagContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "OperationTags" - ], - "operationId": "Tag_DetachFromOperation", - "description": "Detach the tag from the Operation.", - "x-ms-examples": { - "ApiManagementDeleteOperationTag": { - "$ref": "./examples/ApiManagementDeleteOperationTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimapis.json#/parameters/OperationIdParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully detached the tag from the Operation." - }, - "204": { - "description": "Successfully detached the tag from the Operation." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags": { - "get": { - "tags": [ - "OperationsByTags" - ], - "operationId": "Operation_ListByTags", - "description": "Lists a collection of operations associated with tags.", - "x-ms-examples": { - "ApiManagementListOperationsByTags": { - "$ref": "./examples/ApiManagementListOperationsByTags.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of TagResource entities.", - "schema": { - "$ref": "./apimtagresources.json#/definitions/TagResourceCollection" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "./apimtagresources.json#/definitions/TagResourceContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags": { - "get": { - "tags": [ - "ProductTags" - ], - "operationId": "Tag_ListByProduct", - "description": "Lists all Tags associated with the Product.", - "x-ms-examples": { - "ApiManagementGetTagsForProduct": { - "$ref": "./examples/ApiManagementGetTagsForProduct.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimproducts.json#/parameters/ProductIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of tags associated with the Product entity.", - "schema": { - "$ref": "./apimtags.json#/definitions/TagCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "./apimtags.json#/definitions/TagContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}": { - "head": { - "tags": [ - "ProductTags" - ], - "operationId": "Tag_GetEntityStateByProduct", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadProductTag": { - "$ref": "./examples/ApiManagementHeadProductTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimproducts.json#/parameters/ProductIdParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ProductTags" - ], - "operationId": "Tag_GetByProduct", - "description": "Get tag associated with the Product.", - "x-ms-examples": { - "ApiManagementGetProductTag": { - "$ref": "./examples/ApiManagementGetProductTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimproducts.json#/parameters/ProductIdParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the details of the tag specified by its identifier.", - "schema": { - "$ref": "./apimtags.json#/definitions/TagContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductTags" - ], - "operationId": "Tag_AssignToProduct", - "description": "Assign tag to the Product.", - "x-ms-examples": { - "ApiManagementCreateProductTag": { - "$ref": "./examples/ApiManagementCreateProductTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimproducts.json#/parameters/ProductIdParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag was assigned to the Product.", - "schema": { - "$ref": "./apimtags.json#/definitions/TagContract" - } - }, - "200": { - "description": "Tag is already assigned to the Product.", - "schema": { - "$ref": "./apimtags.json#/definitions/TagContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductTags" - ], - "operationId": "Tag_DetachFromProduct", - "description": "Detach the tag from the Product.", - "x-ms-examples": { - "ApiManagementDeleteProductTag": { - "$ref": "./examples/ApiManagementDeleteProductTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimproducts.json#/parameters/ProductIdParameter" - }, - { - "$ref": "#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully detached the tag from the Product." - }, - "204": { - "description": "Successfully detached the tag from the Product." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "TagCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Tag list representation." - }, - "TagContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TagContractProperties", - "description": "Tag entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Tag Contract details." - }, - "TagContractProperties": { - "properties": { - "displayName": { - "type": "string", - "description": "Tag name.", - "maxLength": 160, - "minLength": 1 - } - }, - "required": [ - "displayName" - ], - "description": "Tag contract Properties." - }, - "TagCreateUpdateParameters": { - "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." - }, - "TagDescriptionCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagDescriptionContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged TagDescription list representation." - }, - "TagDescriptionContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TagDescriptionContractProperties", - "description": "TagDescription entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "Contract details." - }, - "TagDescriptionContractProperties": { - "properties": { - "displayName": { - "type": "string", - "description": "Tag name.", - "maxLength": 160, - "minLength": 1 - } - }, - "allOf": [ - { - "$ref": "#/definitions/TagDescriptionBaseProperties" - } - ], - "description": "TagDescription contract Properties." - }, - "TagDescriptionCreateParameters": { - "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." - }, - "TagDescriptionBaseProperties": { - "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." } }, - "parameters": { - "TagIdParameter": { - "name": "tagId", - "in": "path", - "required": true, - "type": "string", - "description": "Tag identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtenant.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtenant.json index e4c1d7bc..212afc10 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtenant.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimtenant.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on tenant entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -34,16 +34,118 @@ } }, "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant": { + "get": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_ListByService", + "description": "Returns list of access infos - for Git and Management endpoints.", + "x-ms-examples": { + "ApiManagementListTenantAccess": { + "$ref": "./examples/ApiManagementListTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Not used" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TenantAccessInfo entities.", + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./definitions.json#/definitions/AccessInformationContract" + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}": { + "head": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_GetEntityTag", + "description": "Tenant access metadata", + "x-ms-examples": { + "ApiManagementHeadTenantAccess": { + "$ref": "./examples/ApiManagementHeadTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, "get": { "tags": [ "TenantAccess" ], "operationId": "TenantAccess_Get", - "description": "Get tenant access information details.", + "description": "Get tenant access information details without secrets.", "x-ms-examples": { "ApiManagementGetTenantAccess": { "$ref": "./examples/ApiManagementGetTenantAccess.json" + }, + "ApiManagementGetTenantGitAccess": { + "$ref": "./examples/ApiManagementGetTenantGitAccess.json" } }, "parameters": [ @@ -60,14 +162,75 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/AccessParameter" + "$ref": "./apimanagement.json#/parameters/AccessParameter" } ], "responses": { "200": { "description": "Tenant Access information.", "schema": { - "$ref": "#/definitions/AccessInformationContract" + "$ref": "./definitions.json#/definitions/AccessInformationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_Create", + "description": "Update tenant access information details.", + "x-ms-examples": { + "ApiManagementCreateTenantAccess": { + "$ref": "./examples/ApiManagementCreateTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationCreateParameters" + }, + "description": "Parameters supplied to retrieve the Tenant Access Information." + }, + { + "$ref": "./apimanagement.json#/parameters/AccessParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Tenant Access information was updated successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationContract" }, "headers": { "ETag": { @@ -75,6 +238,12 @@ "type": "string" } } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } } }, @@ -101,12 +270,12 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AccessInformationUpdateParameters" + "$ref": "./definitions.json#/definitions/AccessInformationUpdateParameters" }, "description": "Parameters supplied to retrieve the Tenant Access Information." }, { - "$ref": "#/parameters/AccessParameter" + "$ref": "./apimanagement.json#/parameters/AccessParameter" }, { "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" @@ -119,8 +288,17 @@ } ], "responses": { - "204": { - "description": "Tenant's access information updated successfully." + "200": { + "description": "Tenant Access information was updated successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/AccessInformationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } }, "default": { "description": "Error response describing why the operation failed.", @@ -137,7 +315,7 @@ "TenantAccess" ], "operationId": "TenantAccess_RegeneratePrimaryKey", - "description": "Regenerate primary access key.", + "description": "Regenerate primary access key", "x-ms-examples": { "ApiManagementTenantAccessRegenerateKey": { "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" @@ -157,7 +335,7 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/AccessParameter" + "$ref": "./apimanagement.json#/parameters/AccessParameter" } ], "responses": { @@ -179,7 +357,7 @@ "TenantAccess" ], "operationId": "TenantAccess_RegenerateSecondaryKey", - "description": "Regenerate secondary access key.", + "description": "Regenerate secondary access key", "x-ms-examples": { "ApiManagementTenantAccessRegenerateKey": { "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" @@ -199,7 +377,7 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/AccessParameter" + "$ref": "./apimanagement.json#/parameters/AccessParameter" } ], "responses": { @@ -215,16 +393,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/listSecrets": { + "post": { "tags": [ - "TenantAccessGit" + "TenantAccess" ], - "operationId": "TenantAccessGit_Get", - "description": "Gets the Git access configuration for the tenant.", + "operationId": "TenantAccess_ListSecrets", + "description": "Get tenant access information details.", "x-ms-examples": { - "ApiManagementGetTenantAccess": { - "$ref": "./examples/ApiManagementGetTenantAccess.json" + "ApiManagementListSecretsTenantAccess": { + "$ref": "./examples/ApiManagementListSecretsTenantAccess.json" } }, "parameters": [ @@ -241,14 +419,14 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/AccessParameter" + "$ref": "./apimanagement.json#/parameters/AccessParameter" } ], "responses": { "200": { - "description": "Git Access Information for the Service.", + "description": "Tenant Access information.", "schema": { - "$ref": "#/definitions/AccessInformationContract" + "$ref": "./definitions.json#/definitions/AccessInformationSecretsContract" }, "headers": { "ETag": { @@ -292,7 +470,7 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/AccessParameter" + "$ref": "./apimanagement.json#/parameters/AccessParameter" } ], "responses": { @@ -334,7 +512,7 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/AccessParameter" + "$ref": "./apimanagement.json#/parameters/AccessParameter" } ], "responses": { @@ -378,7 +556,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/DeployConfigurationParameters" + "$ref": "./definitions.json#/definitions/DeployConfigurationParameters" }, "description": "Deploy Configuration parameters." }, @@ -389,7 +567,7 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ConfigurationParameter" + "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" } ], "responses": { @@ -397,9 +575,9 @@ "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." }, "200": { - "description": "Result of appplying changes from Git branch to database.", + "description": "Result of applying changes from Git branch to database.", "schema": { - "$ref": "#/definitions/OperationResultContract" + "$ref": "./definitions.json#/definitions/OperationResultContract" } }, "default": { @@ -409,7 +587,10 @@ } } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/save": { @@ -440,7 +621,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SaveConfigurationParameter" + "$ref": "./definitions.json#/definitions/SaveConfigurationParameter" }, "description": "Save Configuration parameters." }, @@ -451,7 +632,7 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ConfigurationParameter" + "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" } ], "responses": { @@ -461,7 +642,7 @@ "200": { "description": "Result of creating a commit in the repository.", "schema": { - "$ref": "#/definitions/OperationResultContract" + "$ref": "./definitions.json#/definitions/OperationResultContract" } }, "default": { @@ -471,7 +652,10 @@ } } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/validate": { @@ -498,7 +682,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/DeployConfigurationParameters" + "$ref": "./definitions.json#/definitions/DeployConfigurationParameters" }, "description": "Validate Configuration parameters." }, @@ -509,7 +693,7 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ConfigurationParameter" + "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" } ], "responses": { @@ -519,7 +703,7 @@ "200": { "description": "Result of validating the changes in the specified Git branch.", "schema": { - "$ref": "#/definitions/OperationResultContract" + "$ref": "./definitions.json#/definitions/OperationResultContract" } }, "default": { @@ -529,7 +713,10 @@ } } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/syncState": { @@ -558,215 +745,26 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ConfigurationParameter" + "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" } ], "responses": { "200": { "description": "Sync state result.", "schema": { - "$ref": "#/definitions/TenantConfigurationSyncStateContract" + "$ref": "./definitions.json#/definitions/TenantConfigurationSyncStateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } } } } }, - "definitions": { - "AccessInformationContract": { - "properties": { - "id": { - "type": "string", - "description": "Identifier." - }, - "primaryKey": { - "type": "string", - "description": "Primary access key." - }, - "secondaryKey": { - "type": "string", - "description": "Secondary access key." - }, - "enabled": { - "type": "boolean", - "description": "Tenant access information of the API Management service." - } - }, - "description": "Tenant access information contract of the API Management service." - }, - "AccessInformationUpdateParameters": { - "properties": { - "enabled": { - "type": "boolean", - "description": "Tenant access information of the API Management service." - } - }, - "description": "Tenant access information update parameters of the API Management service." - }, - "DeployConfigurationParameters": { - "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." - }, - "OperationResultContract": { - "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/ErrorResponse", - "description": "Error Body Contract" - }, - "actionLog": { - "type": "array", - "items": { - "$ref": "#/definitions/OperationResultLogItemContract" - }, - "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": { - "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." - }, - "SaveConfigurationParameter": { - "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." - }, - "TenantConfigurationSyncStateContract": { - "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" - } - }, - "description": "Tenant Configuration Synchronization State." - } - }, - "parameters": { - "AccessParameter": { - "name": "accessName", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "access" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "AccessIdName" - }, - "description": "The identifier of the Access configuration.", - "x-ms-parameter-location": "method" - }, - "ConfigurationParameter": { - "name": "configurationName", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "configuration" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "configurationIdName" - }, - "description": "The identifier of the Git Configuration Operation.", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimusers.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimusers.json index e52d1a35..37f99902 100644 --- a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimusers.json +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimusers.json @@ -3,7 +3,7 @@ "info": { "title": "ApiManagementClient", "description": "Use these REST APIs for performing operations on User entity in Azure API Management deployment. The User entity in API Management represents the developers that call the APIs of the products to which they are subscribed.", - "version": "2018-01-01" + "version": "2021-08-01" }, "host": "management.azure.com", "schemes": [ @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users": { "get": { "tags": [ - "Users" + "User" ], "operationId": "User_ListByService", "description": "Lists a collection of registered users in the specified service instance.", @@ -58,7 +58,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|------------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | N/A |\n| registrationDate | ge, le, eq, ne, gt, lt | N/A |\n| note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| groups | expand | | |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -66,6 +66,12 @@ { "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" }, + { + "name": "expandGroups", + "in": "query", + "type": "boolean", + "description": "Detailed Group in response." + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -77,7 +83,7 @@ "200": { "description": "Lists a collection of User entities.", "schema": { - "$ref": "#/definitions/UserCollection" + "$ref": "./definitions.json#/definitions/UserCollection" } }, "default": { @@ -90,13 +96,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/UserContract" + "x-ms-odata": "./definitions.json#/definitions/UserContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}": { "head": { "tags": [ - "Users" + "User" ], "operationId": "User_GetEntityTag", "description": "Gets the entity state (Etag) version of the user specified by its identifier.", @@ -113,7 +119,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -142,7 +148,7 @@ }, "get": { "tags": [ - "Users" + "User" ], "operationId": "User_Get", "description": "Gets the details of the user specified by its identifier.", @@ -159,7 +165,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -172,7 +178,7 @@ "200": { "description": "Gets the specified user entity.", "schema": { - "$ref": "#/definitions/UserContract" + "$ref": "./definitions.json#/definitions/UserContract" }, "headers": { "ETag": { @@ -191,13 +197,13 @@ }, "put": { "tags": [ - "Users" + "User" ], "operationId": "User_CreateOrUpdate", "description": "Creates or Updates a user.", "x-ms-examples": { - "ApiManagementCreateUserBasic": { - "$ref": "./examples/ApiManagementCreateUserBasic.json" + "ApiManagementCreateUser": { + "$ref": "./examples/ApiManagementCreateUser.json" } }, "parameters": [ @@ -208,17 +214,24 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/UserCreateParameters" + "$ref": "./definitions.json#/definitions/UserCreateParameters" }, "description": "Create or update parameters." }, + { + "name": "notify", + "in": "query", + "required": false, + "type": "boolean", + "description": "Send an Email notification to the User." + }, { "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" }, @@ -233,13 +246,25 @@ "201": { "description": "User was successfully created.", "schema": { - "$ref": "#/definitions/UserContract" + "$ref": "./definitions.json#/definitions/UserContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "200": { "description": "User was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, "schema": { - "$ref": "#/definitions/UserContract" + "$ref": "./definitions.json#/definitions/UserContract" } }, "default": { @@ -252,13 +277,13 @@ }, "patch": { "tags": [ - "Users" + "User" ], "operationId": "User_Update", "description": "Updates the details of the user specified by its identifier.", "x-ms-examples": { - "ApiManagementUpdateUserBasic": { - "$ref": "./examples/ApiManagementUpdateUserBasic.json" + "ApiManagementUpdateUser": { + "$ref": "./examples/ApiManagementUpdateUser.json" } }, "parameters": [ @@ -269,14 +294,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/UserUpdateParameters" + "$ref": "./definitions.json#/definitions/UserUpdateParameters" }, "description": "Update parameters." }, @@ -291,11 +316,20 @@ } ], "responses": { - "204": { - "description": "The user details were successfully updated." + "200": { + "description": "User was successfully updated.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + }, + "schema": { + "$ref": "./definitions.json#/definitions/UserContract" + } }, "default": { - "description": "*** Error Responses: ***\n\n * 405 Administrator user cannot be modified\n\n * 4XX Error response giving details why the operation failed.", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "./apimanagement.json#/definitions/ErrorResponse" } @@ -304,7 +338,7 @@ }, "delete": { "tags": [ - "Users" + "User" ], "operationId": "User_Delete", "description": "Deletes specific user.", @@ -321,7 +355,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "name": "deleteSubscriptions", @@ -345,6 +379,9 @@ }, { "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AppTypeParameter" } ], "responses": { @@ -363,7 +400,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/generateSsoUrl": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/generateSsoUrl": { "post": { "tags": [ "Users" @@ -371,8 +408,8 @@ "operationId": "User_GenerateSsoUrl", "description": "Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.", "x-ms-examples": { - "ApiManagementUsersGenerateSsoUrl": { - "$ref": "./examples/ApiManagementUsersGenerateSsoUrl.json" + "ApiManagementUserGenerateSsoUrl": { + "$ref": "./examples/ApiManagementUserGenerateSsoUrl.json" } }, "parameters": [ @@ -383,7 +420,7 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -397,7 +434,7 @@ "description": "The response body contains the single sign-on URL.", "schema": { "x-ms-client-flatten": true, - "$ref": "#/definitions/GenerateSsoUrlResult" + "$ref": "./definitions.json#/definitions/GenerateSsoUrlResult" } }, "default": { @@ -409,10 +446,10 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/groups": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/groups": { "get": { "tags": [ - "UserGroups" + "UserGroup" ], "operationId": "UserGroup_List", "description": "Lists all user groups.", @@ -429,14 +466,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -455,7 +492,7 @@ "200": { "description": "Lists a collection of Group entities.", "schema": { - "$ref": "./apimgroups.json#/definitions/GroupCollection" + "$ref": "./definitions.json#/definitions/GroupCollection" } }, "default": { @@ -468,13 +505,13 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "./apimgroups.json#/definitions/GroupContract" + "x-ms-odata": "./definitions.json#/definitions/GroupContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/subscriptions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions": { "get": { "tags": [ - "UserSubscriptions" + "UserSubscription" ], "operationId": "UserSubscription_List", "description": "Lists the collection of subscriptions of the specified user.", @@ -491,14 +528,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|--------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |" + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
|name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -517,7 +554,7 @@ "200": { "description": "Lists a collection of Subscription entities.", "schema": { - "$ref": "./apimsubscriptions.json#/definitions/SubscriptionCollection" + "$ref": "./definitions.json#/definitions/SubscriptionCollection" } }, "default": { @@ -530,19 +567,19 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "./apimsubscriptions.json#/definitions/SubscriptionContract" + "x-ms-odata": "./definitions.json#/definitions/SubscriptionContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/identities": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions/{sid}": { "get": { "tags": [ - "UserIdentities" + "Subscription" ], - "operationId": "UserIdentities_List", - "description": "Lists all user identities.", + "operationId": "UserSubscription_Get", + "description": "Gets the specified Subscription entity associated with a particular user.", "x-ms-examples": { - "ApiManagementListUsersIdentities": { - "$ref": "./examples/ApiManagementListUsersIdentities.json" + "ApiManagementGetUserSubscription": { + "$ref": "./examples/ApiManagementGetUserSubscription.json" } }, "parameters": [ @@ -553,7 +590,10 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -562,14 +602,62 @@ "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" } ], - "x-ms-pageable": { - "nextLinkName": "nextLink" + "responses": { + "200": { + "description": "The response body contains the specified Subscription entity.", + "schema": { + "$ref": "./definitions.json#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/identities": { + "get": { + "tags": [ + "UserIdentity" + ], + "operationId": "UserIdentities_List", + "description": "List of all user identities.", + "x-ms-examples": { + "ApiManagementListUserIdentities": { + "$ref": "./examples/ApiManagementListUserIdentities.json" + } }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], "responses": { "200": { "description": "Lists of User Identities.", "schema": { - "$ref": "#/definitions/UserIdentityCollection" + "$ref": "./definitions.json#/definitions/UserIdentityCollection" } }, "default": { @@ -578,19 +666,22 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/token": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token": { "post": { "tags": [ - "Users" + "UserToken" ], "operationId": "User_GetSharedAccessToken", "description": "Gets the Shared Access Authorization Token for the User.", "x-ms-examples": { - "ApiManagementUsersGetToken": { - "$ref": "./examples/ApiManagementUsersGetToken.json" + "ApiManagementUserToken": { + "$ref": "./examples/ApiManagementUserToken.json" } }, "parameters": [ @@ -601,14 +692,14 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/UserIdParameter" + "$ref": "./apimanagement.json#/parameters/UserIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/UserTokenParameters" + "$ref": "./definitions.json#/definitions/UserTokenParameters" }, "description": "Create Authorization Token parameters." }, @@ -624,7 +715,7 @@ "description": "The response body contains the authorization token for the user.", "schema": { "x-ms-client-flatten": true, - "$ref": "#/definitions/UserTokenResult" + "$ref": "./definitions.json#/definitions/UserTokenResult" } }, "default": { @@ -635,327 +726,53 @@ } } } - } - }, - "definitions": { - "GenerateSsoUrlResult": { - "properties": { - "value": { - "type": "string", - "description": "Redirect Url containing the SSO URL value." - } - }, - "description": "Generate SSO Url operations response details." - }, - "UserCollection": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/UserContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Users list representation." - }, - "UserContract": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/UserContractProperties", - "description": "User entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./apimanagement.json#/definitions/Resource" - } - ], - "description": "User details." }, - "UserContractProperties": { - "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" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/confirmations/password/send": { + "post": { + "tags": [ + "UserConfirmationPasswordSend" + ], + "operationId": "UserConfirmationPassword_Send", + "description": "Sends confirmation", + "x-ms-examples": { + "ApiManagementUserConfirmationPasswordSend": { + "$ref": "./examples/ApiManagementUserConfirmationPasswordSend.json" + } }, - "groups": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "./apimgroups.json#/definitions/GroupContractProperties" + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" }, - "description": "Collection of groups user is part of." - } - }, - "allOf": [ - { - "$ref": "#/definitions/UserEntityBaseParameters" - } - ], - "description": "User profile." - }, - "UserCreateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/UserCreateParameterProperties", - "description": "User entity create contract properties." - } - }, - "description": "User create details." - }, - "UserCreateParameterProperties": { - "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." - }, - "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." - }, - "UserEntityBaseParameters": { - "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." - } - ] + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/AppTypeParameter" } - }, - "note": { - "type": "string", - "description": "Optional note about a user set by the administrator." - }, - "identities": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/UserIdentityContract" + ], + "responses": { + "204": { + "description": "Notification successfully sent" }, - "description": "Collection of user identities." - } - }, - "description": "User Entity Base Parameters set." - }, - "UserIdentityCollection": { - "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": { - "properties": { - "provider": { - "type": "string", - "description": "Identity provider name." - }, - "id": { - "type": "string", - "description": "Identifier value within provider." - } - }, - "description": "User identity details." - }, - "UserTokenParameters": { - "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 + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } } - }, - "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": { - "properties": { - "value": { - "type": "string", - "description": "Shared Access Authorization token for the User." } - }, - "description": "Get User Token response details." - }, - "UserUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/UserUpdateParametersProperties", - "description": "User entity update contract properties." - } - }, - "description": "User update parameters." - }, - "UserUpdateParametersProperties": { - "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." + } } }, - "parameters": { - "UserIdParameter": { - "name": "uid", - "in": "path", - "required": true, - "type": "string", - "description": "User identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file + "definitions": {}, + "parameters": {} +} diff --git a/App_Data/SwaggerSpecs/Microsoft.ApiManagement/definitions.json b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/definitions.json new file mode 100644 index 00000000..71d6ec31 --- /dev/null +++ b/App_Data/SwaggerSpecs/Microsoft.ApiManagement/definitions.json @@ -0,0 +1,7086 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-08-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": { + "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": { + "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/Resource" + } + ], + "description": "Tenant Settings." + }, + "AccessInformationContractProperties": { + "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": { + "properties": { + "id": { + "type": "string", + "description": "Access Information type ('access' or 'gitAccess')" + }, + "principalId": { + "type": "string", + "description": "Principal (User) Identifier." + }, + "primaryKey": { + "type": "string", + "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + }, + "secondaryKey": { + "type": "string", + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessInformationCreateParameterProperties", + "description": "Tenant access information update parameter properties." + } + }, + "description": "Tenant access information update parameters." + }, + "AccessInformationCreateParameterProperties": { + "properties": { + "principalId": { + "type": "string", + "description": "Principal (User) Identifier." + }, + "primaryKey": { + "type": "string", + "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." + }, + "secondaryKey": { + "type": "string", + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessInformationUpdateParameterProperties", + "description": "Tenant access information update parameter properties." + } + }, + "description": "Tenant access information update parameters." + }, + "AccessInformationUpdateParameterProperties": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether direct access is enabled." + } + }, + "description": "Tenant access information update parameters of the API Management service" + }, + "TenantSettingsCollection": { + "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": { + "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/Resource" + } + ], + "description": "Tenant Settings." + }, + "TenantSettingsContractProperties": { + "properties": { + "settings": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tenant settings" + } + }, + "description": "Tenant access information contract of the API Management service." + }, + "ApiCollection": { + "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." + }, + "ApiContract": { + "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/Resource" + } + ], + "description": "API details." + }, + "ApiContractProperties": { + "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" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiEntityBaseContract" + } + ], + "required": [ + "path" + ], + "description": "API Entity Properties" + }, + "ApiCreateOrUpdateParameter": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiCreateOrUpdateProperties", + "description": "API entity create of update properties." + } + }, + "description": "API Create or Update Parameters." + }, + "ApiCreateOrUpdateProperties": { + "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.", + "enum": [ + "wadl-xml", + "wadl-link-json", + "swagger-json", + "swagger-link-json", + "wsdl", + "wsdl-link", + "openapi", + "openapi+json", + "openapi-link", + "openapi+json-link", + "graphql-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." + } + ] + } + }, + "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.", + "enum": [ + "http", + "soap", + "websocket", + "graphql" + ], + "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" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiContractProperties" + } + ], + "description": "API Create or Update Properties." + }, + "ApiEntityBaseContract": { + "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" + ], + "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": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "ApiRelease details." + }, + "ApiReleaseContractProperties": { + "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": { + "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": { + "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": { + "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": { + "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": { + "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": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "API Version Set Contract details." + }, + "ApiVersionSetContractDetails": { + "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" + ] + }, + "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": { + "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": { + "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": { + "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": { + "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": { + "properties": { + "oAuth2": { + "$ref": "#/definitions/OAuth2AuthenticationSettingsContract", + "description": "OAuth2 Authentication settings" + }, + "openid": { + "$ref": "#/definitions/OpenIdAuthenticationSettingsContract", + "description": "OpenID Connect Authentication Settings" + } + }, + "description": "API Authentication Settings." + }, + "AuthorizationServerCollection": { + "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": { + "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/Resource" + } + ], + "description": "External OAuth authorization server settings." + }, + "AuthorizationServerContractBaseProperties": { + "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": { + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly authorization server name.", + "minLength": 1, + "maxLength": 50 + }, + "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": { + "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/Resource" + } + ], + "description": "External OAuth authorization server settings." + }, + "AuthorizationServerUpdateContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly authorization server name.", + "minLength": 1, + "maxLength": 50 + }, + "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": { + "properties": { + "clientSecret": { + "type": "string", + "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": { + "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": { + "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 Proxy Contract Properties" + }, + "tls": { + "$ref": "#/definitions/BackendTlsProperties", + "description": "Backend TLS Properties" + } + }, + "description": "Backend entity base Parameter set." + }, + "BackendCollection": { + "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": { + "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/Resource" + } + ], + "description": "Backend details." + }, + "BackendContractProperties": { + "properties": { + "url": { + "type": "string", + "description": "Runtime Url of the Backend.", + "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." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BackendBaseParameters" + } + ], + "required": [ + "url", + "protocol" + ], + "description": "Parameters supplied to the Create Backend operation." + }, + "BackendCredentialsContract": { + "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": { + "properties": { + "serviceFabricCluster": { + "$ref": "#/definitions/BackendServiceFabricClusterProperties", + "description": "Backend Service Fabric Cluster Properties" + } + }, + "description": "Properties specific to the Backend Type." + }, + "BackendProxyContract": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendReconnectProperties", + "description": "Reconnect request properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "Reconnect request parameters." + }, + "BackendReconnectProperties": { + "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": { + "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": { + "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": { + "properties": { + "url": { + "type": "string", + "description": "Runtime Url of the Backend.", + "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." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BackendBaseParameters" + } + ], + "description": "Parameters supplied to the Update Backend operation." + }, + "BackendUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendUpdateParameterProperties", + "description": "Backend entity update contract properties." + } + }, + "description": "Backend update parameters." + }, + "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": { + "properties": { + "bytes": { + "type": "integer", + "format": "int32", + "maximum": 8192, + "description": "Number of request body bytes to log." + } + }, + "description": "Body logging settings." + }, + "CacheCollection": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CacheContractProperties", + "description": "Cache properties details." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "Cache details." + }, + "CacheContractProperties": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CacheUpdateProperties", + "description": "Cache update properties details." + } + }, + "description": "Cache update details." + }, + "CacheUpdateProperties": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateContractProperties", + "description": "Certificate properties details." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "Certificate details." + }, + "CertificateContractProperties": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateCreateOrUpdateProperties", + "description": "Certificate create or update properties details." + } + }, + "description": "Certificate create or update details." + }, + "CertificateCreateOrUpdateProperties": { + "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": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeployConfigurationParameterProperties", + "description": "Deploy Configuration Parameter contract properties." + } + }, + "description": "Deploy Tenant Configuration Contract." + }, + "DeployConfigurationParameterProperties": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Diagnostic details." + }, + "DiagnosticContractProperties": { + "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" + }, + "EmailTemplateCollection": { + "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": { + "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/Resource" + } + ], + "description": "Email Template details." + }, + "EmailTemplateContractProperties": { + "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": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EmailTemplateUpdateParameterProperties", + "description": "Email Template Update contract properties." + } + }, + "description": "Email Template update Parameters." + }, + "GenerateSsoUrlResult": { + "properties": { + "value": { + "type": "string", + "description": "Redirect Url containing the SSO URL value." + } + }, + "description": "Generate SSO Url operations response details." + }, + "GroupCollection": { + "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": { + "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/Resource" + } + ], + "description": "Contract details." + }, + "GroupContractProperties": { + "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": { + "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": { + "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": { + "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": { + "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": { + "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": { + "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 + } + }, + "description": "Identity Provider Base Parameter Properties." + }, + "IdentityProviderCreateContract": { + "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/Resource" + } + ], + "description": "Identity Provider details." + }, + "IdentityProviderCreateContractProperties": { + "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": { + "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/Resource" + } + ], + "description": "Identity Provider details." + }, + "IdentityProviderContractProperties": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IdentityProviderUpdateProperties", + "description": "Identity Provider update properties." + } + }, + "description": "Parameters supplied to update Identity Provider" + }, + "IdentityProviderUpdateProperties": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Issue Attachment Contract details." + }, + "IssueAttachmentContractProperties": { + "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": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Issue Comment Contract details." + }, + "IssueCommentContractProperties": { + "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": { + "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/Resource" + } + ], + "description": "Issue Contract details." + }, + "IssueContractBaseProperties": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IssueUpdateContractProperties", + "description": "Issue entity Update contract properties." + } + }, + "description": "Issue update Parameters." + }, + "IssueUpdateContractProperties": { + "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": { + "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": { + "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": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Logger details." + }, + "LoggerContractProperties": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoggerUpdateParameters", + "description": "Logger entity update contract properties." + } + }, + "description": "Logger update contract." + }, + "LoggerUpdateParameters": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Notification details." + }, + "NotificationContractProperties": { + "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": { + "properties": { + "authorizationServerId": { + "type": "string", + "description": "OAuth authorization server identifier." + }, + "scope": { + "type": "string", + "description": "operations scope." + } + }, + "description": "API OAuth2 Authentication settings details." + }, + "OpenIdAuthenticationSettingsContract": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "OpenId Connect Provider details." + }, + "OpenidConnectProviderContractProperties": { + "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." + } + }, + "required": [ + "displayName", + "metadataEndpoint", + "clientId" + ], + "description": "OpenID Connect Providers Contract." + }, + "OpenidConnectProviderUpdateContract": { + "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": { + "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." + } + }, + "description": "Parameters supplied to the Update OpenID Connect Provider operation." + }, + "OperationCollection": { + "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": { + "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/Resource" + } + ], + "description": "API Operation details." + }, + "OperationContractProperties": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Long Running Git Operation Results." + }, + "OperationResultContractProperties": { + "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": { + "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": { + "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": { + "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": { + "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": { + "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": { + "additionalProperties": { + "$ref": "#/definitions/ParameterExampleContract", + "description": "Parameter example." + }, + "description": "Parameter examples." + }, + "ParameterExampleContract": { + "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": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Policy Contract details." + }, + "PolicyContractProperties": { + "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." + }, + "PolicyDescriptionContract": { + "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/Resource" + } + ], + "description": "Policy description details." + }, + "PolicyDescriptionContractProperties": { + "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": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyDescriptionContract" + }, + "description": "Descriptions of APIM policies." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + } + }, + "description": "Descriptions of APIM policies." + }, + "PortalDelegationSettings": { + "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/Resource" + } + ], + "description": "Delegation settings for a developer portal." + }, + "PortalDelegationSettingsProperties": { + "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": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PortalSettingsContract" + }, + "description": "Descriptions of APIM policies." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + } + }, + "description": "Descriptions of APIM policies." + }, + "PortalSettingsContract": { + "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/Resource" + } + ], + "description": "Portal Settings for the Developer Portal." + }, + "PortalSettingsContractProperties": { + "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": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Redirect Anonymous users to the Sign-In page." + } + }, + "description": "Sign-in settings contract properties." + }, + "PortalSigninSettings": { + "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/Resource" + } + ], + "description": "Sign-In settings for the Developer Portal." + }, + "PortalSignupSettings": { + "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/Resource" + } + ], + "description": "Sign-Up settings for a developer portal." + }, + "PortalSignupSettingsProperties": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Product details." + }, + "ProductContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Product name.", + "minLength": 1, + "maxLength": 300 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProductEntityBaseParameters" + } + ], + "required": [ + "displayName" + ], + "description": "Product profile." + }, + "ProductEntityBaseParameters": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProductUpdateProperties", + "description": "Product entity Update contract properties." + } + }, + "description": "Product Update parameters." + }, + "ProductUpdateProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Product name.", + "maxLength": 300, + "minLength": 1 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProductEntityBaseParameters" + } + ], + "description": "Parameters supplied to the Update Product operation." + }, + "NamedValueCollection": { + "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": { + "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/Resource" + } + ], + "description": "NamedValue details." + }, + "NamedValueCreateContractProperties": { + "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": { + "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/Resource" + } + ], + "description": "NamedValue details." + }, + "NamedValueContractProperties": { + "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." + } + }, + "allOf": [ + { + "$ref": "#/definitions/NamedValueEntityBaseParameters" + } + ], + "required": [ + "displayName" + ], + "description": "NamedValue Contract properties." + }, + "NamedValueEntityBaseParameters": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NamedValueUpdateParameterProperties", + "description": "NamedValue entity Update contract properties." + } + }, + "description": "NamedValue update Parameters." + }, + "QuotaCounterCollection": { + "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": { + "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": { + "properties": { + "value": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota counter Value Properties." + } + }, + "description": "Quota counter value details." + }, + "QuotaCounterValueContractProperties": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota counter value details." + } + }, + "description": "Quota counter value details." + }, + "RecipientEmailCollection": { + "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": { + "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/Resource" + } + ], + "description": "Recipient Email details." + }, + "RecipientEmailContractProperties": { + "properties": { + "email": { + "type": "string", + "description": "User Email subscribed to notification." + } + }, + "description": "Recipient Email Contract Properties." + }, + "RecipientsContractProperties": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Recipient User details." + }, + "RecipientUsersContractProperties": { + "properties": { + "userId": { + "type": "string", + "description": "API Management UserId subscribed to notification." + } + }, + "description": "Recipient User Contract Properties." + }, + "RegistrationDelegationSettingsProperties": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable delegation for user registration." + } + }, + "description": "User registration delegation settings properties." + }, + "ReportCollection": { + "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": { + "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 proxy 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": { + "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": { + "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": { + "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": { + "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." + }, + "ResponseContract": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SaveConfigurationParameterProperties", + "description": "Properties of the Save Configuration Parameters." + } + }, + "description": "Save Tenant Configuration Contract details." + }, + "SaveConfigurationParameterProperties": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "API Schema Contract details." + }, + "SchemaContractProperties": { + "properties": { + "contentType": { + "type": "string", + "description": "Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`." + }, + "document": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SchemaDocumentProperties", + "description": "Create or update Properties of the API Schema Document." + } + }, + "required": [ + "contentType" + ], + "description": "API Schema create or update contract Properties." + }, + "SchemaDocumentProperties": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Global Schema Contract details." + }, + "GlobalSchemaContractProperties": { + "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)." + } + }, + "required": [ + "schemaType" + ], + "description": "Schema create or update contract Properties." + }, + "GlobalSchemaDocumentProperties": { + "type": "object", + "description": "Global Schema Document Properties." + }, + "SubscriptionCollection": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionContractProperties", + "description": "Subscription contract properties." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "Subscription details." + }, + "SubscriptionContractProperties": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionCreateParameterProperties", + "description": "Subscription contract properties." + } + }, + "description": "Subscription create details." + }, + "SubscriptionKeyParameterNamesContract": { + "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": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable delegation for subscriptions." + } + }, + "description": "Subscriptions delegation settings properties." + }, + "SubscriptionUpdateParameterProperties": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionUpdateParameterProperties", + "description": "Subscription Update contract properties." + } + }, + "description": "Subscription update details." + }, + "TagCollection": { + "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": { + "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/Resource" + } + ], + "description": "Tag Contract details." + }, + "TagContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Tag name.", + "maxLength": 160, + "minLength": 1 + } + }, + "required": [ + "displayName" + ], + "description": "Tag contract Properties." + }, + "TagCreateUpdateParameters": { + "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": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Contract details." + }, + "TagDescriptionContractProperties": { + "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": { + "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": { + "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": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Result of Tenant Configuration Sync State." + }, + "TenantConfigurationSyncStateContractProperties": { + "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": { + "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": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "User details." + }, + "UserContractProperties": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserCreateParameterProperties", + "description": "User entity create contract properties." + } + }, + "description": "User create details." + }, + "UserEntityBaseParameters": { + "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": { + "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": { + "properties": { + "provider": { + "type": "string", + "description": "Identity provider name." + }, + "id": { + "type": "string", + "description": "Identifier value within provider." + } + }, + "description": "User identity details." + }, + "UserTokenParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserTokenParameterProperties", + "description": "User Token Parameter contract properties." + } + }, + "description": "Get User Token parameters." + }, + "UserTokenParameterProperties": { + "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": { + "properties": { + "value": { + "type": "string", + "description": "Shared Access Authorization token for the User." + } + }, + "description": "Get User Token response details." + }, + "UserUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserUpdateParametersProperties", + "description": "User entity update contract properties." + } + }, + "description": "User update parameters." + }, + "UserUpdateParametersProperties": { + "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": { + "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": { + "properties": { + "clientSecret": { + "type": "string", + "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": { + "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": { + "properties": { + "validationKey": { + "type": "string", + "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": { + "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": { + "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": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GatewayContractProperties", + "description": "Gateway details." + } + }, + "allOf": [ + { + "$ref": "./../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "Gateway details." + }, + "GatewayContractProperties": { + "properties": { + "locationData": { + "$ref": "#/definitions/ResourceLocationDataContract", + "description": "Gateway location." + }, + "description": { + "type": "string", + "description": "Gateway description", + "maxLength": 1000 + } + }, + "description": "Properties of the Gateway contract." + }, + "ResourceLocationDataContract": { + "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": { + "properties": { + "primary": { + "type": "string", + "description": "Primary gateway key." + }, + "secondary": { + "type": "string", + "description": "Secondary gateway key." + } + }, + "description": "Gateway authentication keys." + }, + "GatewayTokenRequestContract": { + "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": { + "properties": { + "value": { + "type": "string", + "description": "Shared Access Authentication token value for the Gateway." + } + }, + "description": "Gateway access token." + }, + "GatewayKeyRegenerationRequestContract": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Gateway hostname configuration details." + }, + "GatewayHostnameConfigurationContractProperties": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Gateway certificate authority details." + }, + "GatewayCertificateAuthorityContractProperties": { + "properties": { + "isTrusted": { + "type": "boolean", + "description": "Determines whether certificate authority is trusted." + } + }, + "description": "Gateway certificate authority details." + }, + "AssociationContract": { + "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/Resource" + } + ], + "description": "Association entity details." + }, + "ContentTypeCollection": { + "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": { + "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/Resource" + } + ], + "description": "Content type contract details." + }, + "ContentTypeContractProperties": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Content type contract details." + }, + "ContentItemContractProperties": { + "properties": {}, + "additionalProperties": true + }, + "DeletedServicesCollection": { + "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": { + "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/Resource" + } + ], + "description": "Deleted API Management Service information." + }, + "DeletedServiceContractProperties": { + "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": { + "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": { + "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/Resource" + } + ], + "description": "Portal Revision's contract details." + }, + "PortalRevisionContractProperties": { + "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." + } + } + }, + "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" + } + } + }, + "parameters": {} +}