Skip to content

Apim 2019 12 01 preview #7725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
solankisamir merged 7 commits into from
Dec 18, 2019
Merged

Apim 2019 12 01 preview #7725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
53de5bc
ApiManagement - tagDescription id
Nov 6, 2019
dd6d353
ApiManagement - policyDescriptions
Nov 7, 2019
96132bc
ApiManagement - policyDescriptions small fix
Nov 7, 2019
4d0b4e0
ApiManagement - policyDescriptions sample
Nov 25, 2019
dcc017e
ApiManagement - revisions id and api schema doc
Nov 25, 2019
c16fbbe
ApiManagement - tag descriptions list example
Nov 25, 2019
4567770
ApiManagement - ciphers info
Dec 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions ...nt/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimanagement.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,17 @@
"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",
Expand Down
12 changes: 6 additions & 6 deletions ...agement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimapis.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2305,7 +2305,7 @@
"in": "body",
"required": true,
"schema": {
"$ref": "./definitions.json#/definitions/SchemaCreateOrUpdateContract"
"$ref": "./definitions.json#/definitions/SchemaContract"
},
"description": "The schema contents to apply."
},
Expand Down Expand Up @@ -3794,7 +3794,7 @@
"x-ms-odata": "./definitions.json#/definitions/TagDescriptionContract"
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagId}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}": {
"head": {
"tags": [
"ApiTagDescription"
Expand All @@ -3817,7 +3817,7 @@
"$ref": "./apimanagement.json#/parameters/ApiIdRevParameter"
},
{
"$ref": "./apimanagement.json#/parameters/TagIdParameter"
"$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
Expand Down Expand Up @@ -3866,7 +3866,7 @@
"$ref": "./apimanagement.json#/parameters/ApiIdRevParameter"
},
{
"$ref": "./apimanagement.json#/parameters/TagIdParameter"
"$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
Expand Down Expand Up @@ -3918,7 +3918,7 @@
"$ref": "./apimanagement.json#/parameters/ApiIdRevParameter"
},
{
"$ref": "./apimanagement.json#/parameters/TagIdParameter"
"$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter"
},
{
"name": "parameters",
Expand Down Expand Up @@ -3994,7 +3994,7 @@
"$ref": "./apimanagement.json#/parameters/ApiIdRevParameter"
},
{
"$ref": "./apimanagement.json#/parameters/TagIdParameter"
"$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
Expand Down
2 changes: 1 addition & 1 deletion ...t/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimdeployment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1065,7 +1065,7 @@
"additionalProperties": {
"type": "string"
},
"description": "Custom properties of the API Management service.</br>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).</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.</br>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`.</br></br>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."
"description": "Custom properties of the API Management service.</br>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).</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.</br>Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.</br>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`.</br></br>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",
Expand Down
16 changes: 8 additions & 8 deletions ...019-12-01-preview/apimpolicysnippets.json → ...12-01-preview/apimpolicydescriptions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policySnippets": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions": {
"get": {
"tags": [
"PolicySnippet"
"PolicyDescription"
],
"operationId": "PolicySnippet_ListByService",
"description": "Lists all policy snippets.",
"operationId": "PolicyDescription_ListByService",
"description": "Lists all policy descriptions.",
"x-ms-examples": {
"ApiManagementListPolicySnippets": {
"$ref": "./examples/ApiManagementListPolicySnippets.json"
"ApiManagementListPolicyDescriptions": {
"$ref": "./examples/ApiManagementListPolicyDescriptions.json"
}
},
"parameters": [
Expand Down Expand Up @@ -80,9 +80,9 @@
],
"responses": {
"200": {
"description": "Returns an array of Policy Snippets.",
"description": "Returns an array of policy descriptions.",
"schema": {
"$ref": "./definitions.json#/definitions/PolicySnippetsCollection"
"$ref": "./definitions.json#/definitions/PolicyDescriptionCollection"
}
},
"default": {
Expand Down
92 changes: 42 additions & 50 deletions ...ment/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/definitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,11 @@
},
"ApiRevisionContract": {
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "Resource ID."
},
"apiId": {
"type": "string",
"readOnly": true,
Expand Down Expand Up @@ -3232,21 +3237,26 @@
],
"description": "Policy contract Properties."
},
"PolicySnippetContract": {
"PolicyDescriptionContract": {
"properties": {
"name": {
"type": "string",
"description": "Snippet name.",
"readOnly": true
},
"content": {
"type": "string",
"description": "Snippet content.",
"readOnly": true
},
"toolTip": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/PolicyDescriptionContractProperties",
"description": "Policy description contract properties."
}
},
"allOf": [
{
"$ref": "./apimanagement.json#/definitions/Resource"
}
],
"description": "Policy description details."
},
"PolicyDescriptionContractProperties": {
"properties": {
"description": {
"type": "string",
"description": "Snippet toolTip.",
"description": "Policy description.",
"readOnly": true
},
"scope": {
Expand All @@ -3255,19 +3265,24 @@
"readOnly": true
}
},
"description": "Policy snippet."
"description": "Policy description properties."
},
"PolicySnippetsCollection": {
"PolicyDescriptionCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicySnippetContract"
"$ref": "#/definitions/PolicyDescriptionContract"
},
"description": "Policy snippet value."
"description": "Descriptions of APIM policies."
},
"count": {
"type": "integer",
"format": "int64",
"description": "Total record count number."
}
},
"description": "The response of the list policy snippets operation."
"description": "Descriptions of APIM policies."
},
"PortalDelegationSettings": {
"properties": {
Expand Down Expand Up @@ -4208,21 +4223,6 @@
},
"description": "The response of the list schema operation."
},
"SchemaCreateOrUpdateContract": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/SchemaCreateOrUpdateProperties",
"description": "Properties of the Schema."
}
},
"allOf": [
{
"$ref": "./apimanagement.json#/definitions/Resource"
}
],
"description": "Schema Contract details."
},
"SchemaContract": {
"properties": {
"properties": {
Expand All @@ -4239,22 +4239,6 @@
"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). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`. "
},
"document": {
"type": "object",
"description": "Properties of the Schema Document."
}
},
"required": [
"contentType"
],
"description": "Schema contract Properties."
},
"SchemaCreateOrUpdateProperties": {
"properties": {
"contentType": {
"type": "string",
Expand All @@ -4275,7 +4259,11 @@
"properties": {
"value": {
"type": "string",
"description": "Json escaped string defining the document representing the Schema."
"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 schemas only, null otherwise."
}
},
"description": "Schema Document Properties."
Expand Down Expand Up @@ -4664,6 +4652,10 @@
},
"TagDescriptionContractProperties": {
"properties": {
"tagId": {
"type": "string",
"description": "Identifier of the tag in the form of /tags/{tagId}"
},
"displayName": {
"type": "string",
"description": "Tag name.",
Expand Down
16 changes: 9 additions & 7 deletions ...iManagement/preview/2019-12-01-preview/examples/ApiManagementCreateApiTagDescription.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"api-version": "2019-12-01-preview",
"subscriptionId": "subid",
"apiId": "5931a75ae4bbd512a88c680b",
"tagId": "tagId1",
"tagDescriptionId": "tagId1",
"parameters": {
"properties": {
"description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
Expand All @@ -17,25 +17,27 @@
"responses": {
"201": {
"body": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
"type": "Microsoft.ApiManagement/service/tags",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1",
"type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
"name": "tagId1",
"properties": {
"tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
"displayName": "tag1",
"description": null,
"description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
"externalDocsDescription": "some additional info",
"externalDocsUrl": "http://some_url.com"
}
}
},
"200": {
"body": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
"type": "Microsoft.ApiManagement/service/tags",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1",
"type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
"name": "tagId1",
"properties": {
"tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
"displayName": "tag1",
"description": null,
"description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
"externalDocsDescription": "some additional info",
"externalDocsUrl": "http://some_url.com"
}
Expand Down
2 changes: 1 addition & 1 deletion ...iManagement/preview/2019-12-01-preview/examples/ApiManagementDeleteApiTagDescription.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"api-version": "2019-12-01-preview",
"subscriptionId": "subid",
"apiId": "59d5b28d1f7fab116c282650",
"tagId": "59d5b28e1f7fab116402044e",
"tagDescriptionId": "59d5b28e1f7fab116402044e",
"If-Match": "*"
},
"responses": {
Expand Down
7 changes: 4 additions & 3 deletions ....ApiManagement/preview/2019-12-01-preview/examples/ApiManagementGetApiTagDescription.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@
"api-version": "2019-12-01-preview",
"subscriptionId": "subid",
"apiId": "59d6bb8f1f7fab13dc67ec9b",
"tagId": "59306a29e4bbd510dc24e5f9"
"tagDescriptionId": "59306a29e4bbd510dc24e5f9"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9",
"type": "Microsoft.ApiManagement/service/tags",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/tagDescriptions/59306a29e4bbd510dc24e5f9",
"type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
"name": "59306a29e4bbd510dc24e5f9",
"properties": {
"tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9",
"displayName": "tag1",
"description": null,
"externalDocsDescription": "some additional info",
Expand Down
2 changes: 1 addition & 1 deletion ...ApiManagement/preview/2019-12-01-preview/examples/ApiManagementHeadApiTagDescription.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"api-version": "2019-12-01-preview",
"subscriptionId": "subid",
"apiId": "59d6bb8f1f7fab13dc67ec9b",
"tagId": "59306a29e4bbd510dc24e5f9"
"tagDescriptionId": "59306a29e4bbd510dc24e5f9"
},
"responses": {
"200": {
Expand Down
1 change: 1 addition & 0 deletions ...soft.ApiManagement/preview/2019-12-01-preview/examples/ApiManagementListApiRevisions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"body": {
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1/revisions/a1;rev=1",
"apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1",
"apiRevision": "1",
"createdDateTime": "2018-02-01T22:21:20.467Z",
Expand Down
3 changes: 2 additions & 1 deletion ...piManagement/preview/2019-12-01-preview/examples/ApiManagementListApiTagDescriptions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@
"body": {
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tagDescriptions/5600b539c53f5b0062060002",
"type": "Microsoft.ApiManagement/service/tags",
"name": "5600b539c53f5b0062060002",
"properties": {
"tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002",
"displayName": "tag1",
"externalDocsDescription": "some additional info",
"externalDocsUrl": "http://some_url.com"
Expand Down
Loading