Skip to content
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.

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

feat)Gateway): Adding gateway config resource #28478

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
5f06a19
added gateway config resource
vidishamsft Mar 27, 2024
ba203f9
removing Head gateway Config call
vidishamsft Mar 27, 2024
4a8f029
updates
vidishamsft Mar 27, 2024
b404dd5
resolving errors
vidishamsft Mar 27, 2024
3a2e0dc
trying to resolve more model validations
vidishamsft Mar 27, 2024
0397a4e
resolving some model validations
vidishamsft Mar 27, 2024
119a56f
resolving model validations
vidishamsft Mar 27, 2024
e5a5a77
resoloving delete example errors
vidishamsft Mar 27, 2024
9daf3c4
Swagger Prettier
vidishamsft Mar 27, 2024
f6e03ee
Merge branch 'release-ApiManagement-2023-09-01-preview' into gatewayC…
solankisamir Mar 28, 2024
884fa54
prettier
vidishamsft Mar 28, 2024
ac071e3
Merge branch 'gatewayConfig-2023-09-01-preview' of https://github.com…
vidishamsft Mar 28, 2024
f46d505
updating so patch has same response as get and put
vidishamsft Apr 11, 2024
54c5af5
removing path for gateway config
vidishamsft Apr 11, 2024
b417831
Merge branch 'release-ApiManagement-2023-09-01-preview' into gatewayC…
solankisamir Apr 15, 2024
4ec94e2
addressing comment
vidishamsft Apr 29, 2024
25c5b03
Merge branch 'gatewayConfig-2023-09-01-preview' of https://github.com…
vidishamsft Apr 29, 2024
3d95ca2
addressing comments
vidishamsft Apr 30, 2024
afb3abb
nit
vidishamsft Apr 30, 2024
8d79ff5
path updatess
vidishamsft May 1, 2024
0771289
updating as per comments
vidishamsft May 3, 2024
c931bf8
Adding workspaceLinks
vidishamsft May 12, 2024
e501473
resolving some of the errors
vidishamsft May 12, 2024
028e9c2
resolved some errors
vidishamsft May 12, 2024
71a3aa8
resolving some of the errors
vidishamsft May 12, 2024
3414256
resolving some more errors
vidishamsft May 13, 2024
a100276
npx prettier
vidishamsft May 13, 2024
da99dd6
addressing comments
vidishamsft May 14, 2024
550148a
updated based on comments
vidishamsft May 19, 2024
956d6db
Merge branch 'release-ApiManagement-2023-09-01-preview' into gatewayC…
solankisamir May 19, 2024
a4cb02d
lint updates
vidishamsft May 20, 2024
7f3c6ce
Merge branch 'gatewayConfig-2023-09-01-preview' of https://github.com…
vidishamsft May 20, 2024
98f8c69
nit updates
vidishamsft May 20, 2024
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
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,18 @@
"type": "string",
"description": "The name of the API Management gateway.",
"minLength": 1,
"maxLength": 50,
"maxLength": 45,
"pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"x-ms-parameter-location": "method"
},
"ConfigConnectionNameParameter": {
"name": "configConnectionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the API Management gateway config connection.",
"minLength": 1,
"maxLength": 30,
"pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"x-ms-parameter-location": "method"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,337 @@
{
"swagger": "2.0",
vidishamsft marked this conversation as resolved.
Show resolved Hide resolved
"info": {
"title": "ApiManagementClient",
"description": "Use these REST APIs to manage Azure API Management gateway config connections deployments.",
"version": "2023-09-01-preview"
},
"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/gateways/{gatewayName}/configConnections": {
"get": {
"tags": [
"ApiManagementGatewayConfigConnection"
],
"operationId": "ApiManagementGatewayConfigConnection_ListByGateway",
"description": "List all API Management gateway config connections within a gateway.",
"x-ms-examples": {
"ApiManagementListGatewayConfigConnection": {
"$ref": "./examples/ApiManagementListGatewayConfigConnection.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/GatewayNameParameter"
}
],
"responses": {
"200": {
"description": "The API Management gateway config connection list.",
"schema": {
"$ref": "#/definitions/ApiManagementGatewayConfigConnectionListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName}": {
"get": {
"tags": [
"ApiManagementGatewayConfigConnection"
],
"operationId": "ApiManagementGatewayConfigConnection_Get",
"description": "Gets an API Management gateway config connection resource description.",
"x-ms-examples": {
"ApiManagementGetGatewayConfigConnection": {
"$ref": "./examples/ApiManagementGetGatewayConfigConnection.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/GatewayNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ConfigConnectionNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Successfully got the API Management gateway config connection resource.",
"schema": {
"$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
}
},
"put": {
"tags": [
"ApiManagementGatewayConfigConnection"
],
"operationId": "ApiManagementGatewayConfigConnection_CreateOrUpdate",
"description": "Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.",
"x-ms-examples": {
"ApiManagementCreateGatewayConfigConnection": {
"$ref": "./examples/ApiManagementCreateGatewayConfigConnection.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/GatewayNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ConfigConnectionNameParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource"
},
"description": "Parameters supplied to the CreateOrUpdate API Management gateway config connection operation."
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The gateway config connection was successfully updated.",
"schema": {
"$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource"
}
},
"201": {
"description": "The gateway config connection was successfully created.",
"schema": {
"$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
},
"delete": {
"tags": [
"ApiManagementGatewayConfigConnection"
],
"operationId": "ApiManagementGatewayConfigConnection_Delete",
"description": "Deletes an existing API Management gateway config connection.",
"x-ms-examples": {
"ApiManagementGatewayDeleteGateway": {
"$ref": "./examples/ApiManagementDeleteGatewayConfigConnection.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/GatewayNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ConfigConnectionNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"202": {
"description": "The gateway config connection delete request was accepted.",
"headers": {
"location": {
"description": "Location header",
"type": "string"
}
}
},
"204": {
"description": "The gateway config connection does not exist."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true
}
}
},
"definitions": {
"GatewayConfigConnectionBaseProperties": {
vidishamsft marked this conversation as resolved.
Show resolved Hide resolved
"type": "object",
"properties": {
"provisioningState": {
vidishamsft marked this conversation as resolved.
Show resolved Hide resolved
"readOnly": true,
"type": "string",
"description": "The current provisioning state of the API Management gateway config connection ",
"enum": [
"Activating",
"Canceled",
"Failed",
"Succeeded",
"Terminating",
"Upgrading",
"Updating"
],
"x-ms-enum": {
"name": "ProvisioningState",
"modelAsString": true
}
},
"sourceId": {
"type": "string",
"format": "arm-id",
"x-ms-arm-id-details": {
"allowedResources": [
{
"type": "Microsoft.ApiManagement/service/workspaces"
}
]
},
"description": "The link to the API Management service workspace."
vidishamsft marked this conversation as resolved.
Show resolved Hide resolved
},
"defaultHostname": {
"readOnly": true,
"type": "string",
"description": "The default hostname of the data-plane gateway."
},
"hostnames": {
"type": "array",
"items": {
"type": "string"
},
"description": "The hostnames of the data-plane gateway to which requests can be sent."
}
}
},
"ApiManagementGatewayConfigConnectionResource": {
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/GatewayConfigConnectionBaseProperties",
"description": "Properties of the API Management gateway config connection."
},
"etag": {
"type": "string",
"description": "ETag of the resource.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "./../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
],
"required": [
"properties"
],
"description": "A single API Management gateway resource in List or Get response."
},
"ApiManagementGatewayConfigConnectionListResult": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource"
},
"description": "Result of the List API Management gateway config connection operation."
},
"nextLink": {
"type": "string",
"description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services."
}
},
"required": [
"value"
],
"description": "The response of the List API Management gateway operation."
}
},
"parameters": {}
}
Loading