Skip to content

Update workspace/gateway APIs with new fields #31738

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
Samir Solanki (solankisamir) merged 6 commits into from
Dec 13, 2024
Merged

Update workspace/gateway APIs with new fields #31738

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
52c6159
Update workspace/gateway APIs with new fields
halspang Dec 3, 2024
4c40981
Incorporate feedback
halspang Dec 5, 2024
73abb84
Additional feedback
halspang Dec 6, 2024
6c58864
Remove Kind from workspace
halspang Dec 10, 2024
4b2a901
Fiixes for lint/prettier
halspang Dec 10, 2024
cc9cc0f
Remove required hostname from workspace contract
halspang Dec 13, 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
23 changes: 23 additions & 0 deletions ...ement/resource-manager/Microsoft.ApiManagement/preview/2024-10-01-preview/apigateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,6 +666,29 @@
"type": "string",
"description": "ETag of the resource.",
"readOnly": true
},
"kind": {
"type": "string",
"readOnly": true,
Comment thread
halspang marked this conversation as resolved.
Outdated
"description": "The kind of gateway.",
"enum": [
"KubernetesManaged",
"Default"
],
"x-ms-enum": {
"name": "GatewayKind",
"modelAsString": true,
"values": [
{
"value": "KubernetesManaged",
"description": "Gateway managed by Kubernetes resources."
Comment thread
halspang marked this conversation as resolved.
Outdated
},
{
"value": "Default",
"description": "Default kind of gateway."
Comment thread
halspang marked this conversation as resolved.
Outdated
}
]
Comment thread
halspang marked this conversation as resolved.
}
}
},
"allOf": [
Expand Down
8 changes: 7 additions & 1 deletion ...t/resource-manager/Microsoft.ApiManagement/preview/2024-10-01-preview/apimworkspaces.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,10 @@
"x-ms-examples": {
"ApiManagementGetWorkspace": {
"$ref": "./examples/ApiManagementGetWorkspace.json"
}
},
"ApiManagementGetKubernetesManagedWorkspace": {
"$ref": "./examples/ApiManagementGetKubernetesManagedWorkspace.json"
},
},
"parameters": [
{
Expand Down Expand Up @@ -198,6 +201,9 @@
"x-ms-examples": {
"ApiManagementCreateWorkspace": {
"$ref": "./examples/ApiManagementCreateWorkspace.json"
},
"ApiManagementCreateKubernetesWorkspace": {
"$ref": "./examples/ApiManagementCreateKubernetesWorkspace.json"
}
},
"parameters": [
Expand Down
58 changes: 58 additions & 0 deletions ...ment/resource-manager/Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9232,13 +9232,71 @@
"description": {
"type": "string",
"description": "Description of the workspace."
},
"kind": {
"type": "string",
"readOnly": true,
"description": "The kind of Gateway.",
Comment thread
halspang marked this conversation as resolved.
Outdated
"enum": [
"KubernetesManaged",
"Default"
],
"x-ms-enum": {
"name": "GatewayKind",

@tomkerkhove Tom Kerkhove (tomkerkhove) Dec 6, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Samir Solanki (@solankisamir) Should we rename this to WorkspaceKind given this is on workspace resource, or should we keep calling it GatewayKind to keep enums aligned in generated code?

I'm inclined to say - Should be renamed to WorkspaceKind?

@halspang halspang Dec 6, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to WorkspaceKind as I agree that it looks better to match the resource. Will revert if advised otherwise.

"modelAsString": true,
"values": [
{
"value": "KubernetesManaged",
"description": "Gateway managed by Kubernetes resources."
Comment thread
halspang marked this conversation as resolved.
Outdated
},
{
"value": "Default",
"description": "Default kind of gateway."
Comment thread
halspang marked this conversation as resolved.
Outdated
}
]
}
},
"provisioningState": {
Comment thread
halspang marked this conversation as resolved.
Outdated
"type": "string",
"description": "Provisioning state.",
"enum": [
"Created",
"Succeeded"
],
"x-ms-enum": {
"name": "ProvisioningState",
"modelAsString": false
}
},
"configurationApi": {
Comment thread
halspang marked this conversation as resolved.
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ConfigurationApiProperties",
"description": "Configuration API properties."
}
}
}
},
"required": [
"displayName"
],
"description": "Workspace entity properties."
},
"ConfigurationApiProperties": {
"type": "object",
"properties": {
"hostname": {
"type": "string",
"description": "Hostname of the configuration API."
}
},
"required": [
"hostname"
],
"description": "Configuration API properties."
},
"ProductApiLinkCollection": {
"type": "object",
"properties": {
Expand Down
51 changes: 51 additions & 0 deletions ...anagement/preview/2024-10-01-preview/examples/ApiManagementCreateKubernetesWorkspace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
{
"parameters": {
"serviceName": "apimService1",
"resourceGroupName": "rg1",
"api-version": "2024-10-01-preview",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"workspaceId": "wks1",
"kind": "KubernetesManaged",
Comment thread
halspang marked this conversation as resolved.
Outdated
"parameters": {
"properties": {
"displayName": "my workspace",
"description": "workspace 1"
}
}
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1",
"type": "Microsoft.ApiManagement/service/workspaces",
"name": "wks1",
"kind": "KubernetesManaged",
"properties": {
"provisioningState": "Created",
Comment thread
halspang marked this conversation as resolved.
Outdated
"description": "workspace 1",
"displayName": "my workspace",
"configurationApi": {
"hostname": "example.eastus.configuration.gateway.azure-api.net"
}
}
}
},
"200": {
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1",
"type": "Microsoft.ApiManagement/service/workspaces",
"name": "wks1",
"kind": "KubernetesManaged",
"properties": {
"provisioningState": "Succeeded",
Comment thread
halspang marked this conversation as resolved.
Outdated
"description": "workspace 1",
"displayName": "my workspace",
"configurationApi": {
"hostname": "example.eastus.configuration.gateway.azure-api.net"
}
}
}
}
}
}

105 changes: 105 additions & 0 deletions ...4-10-01-preview/examples/ApiManagementCreateWorkspacePremiumGatewayKubernetesManaged.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
{
"parameters": {
"gatewayName": "apimGateway1",
"resourceGroupName": "rg1",
"api-version": "2024-10-01-preview",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"parameters": {
"properties": {
"backend": {
"subnet": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
}
},
"virtualNetworkType": "External"

@tomkerkhove Tom Kerkhove (tomkerkhove) Dec 5, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't support external VNET so let's remove this.

@halspang halspang Dec 5, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@tomkerkhove Tom Kerkhove (tomkerkhove) Dec 6, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still see it though

@tomkerkhove Tom Kerkhove (tomkerkhove) Dec 6, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"virtualNetworkType": "External"

},
"sku": {
"name": "WorkspaceGatewayPremium",
"capacity": 1
},
"location": "South Central US",
"tags": {
"Name": "Contoso",
"Test": "User"
},
"kind": "KubernetesManaged"
}
},
"responses": {
"201": {
"headers": {
"Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse",
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse"
},
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
"name": "apimGateway1",
"type": "Microsoft.ApiManagement/gateway",
Comment thread
halspang marked this conversation as resolved.
"tags": {
"api-version": "2024-10-01-preview"
},
"location": "East US",
"etag": "AAAAAAAmRAM=",
"properties": {
"provisioningState": "Created",
"targetProvisioningState": "Activating",
"createdAtUtc": "2022-07-11T18:41:01.2506031Z",
"backend": {
"subnet": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
}
},
"virtualNetworkType": "External"
Comment thread
halspang marked this conversation as resolved.
Outdated
},
"sku": {
"name": "WorkspaceGatewayPremium",
"capacity": 1
},
"systemData": {
"createdBy": "user@contoso.com",
"createdByType": "User",
"createdAt": "2022-07-11T18:41:00.9390609Z",
"lastModifiedBy": "user@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
}
}
},
"200": {
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
"name": "apimGateway1",
"type": "Microsoft.ApiManagement/gateways",
Comment thread
halspang marked this conversation as resolved.
"tags": {
"api-version": "2024-10-01-preview"
},
"location": "East US",
"etag": "AAAAAAAmREI=",
"properties": {
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2022-07-11T18:41:01.2506031Z",
"backend": {
"subnet": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
}
},
"virtualNetworkType": "External"
},
"sku": {
"name": "WorkspaceGatewayPremium",
"capacity": 1
},
"systemData": {
"createdBy": "user@contoso.com",
"createdByType": "User",
"createdAt": "2022-07-11T18:41:00.9390609Z",
"lastModifiedBy": "user@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
}
}
}
}
}

53 changes: 53 additions & 0 deletions .../preview/2024-10-01-preview/examples/ApiManagementGatewayGetKubernetesManagedGateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
{
"parameters": {
"gatewayName": "apimService1",
"resourceGroupName": "rg1",
"api-version": "2024-10-01-preview",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway",
Comment thread
halspang marked this conversation as resolved.
"name": "example-gateway",
"type": "Microsoft.ApiManagement/gateway",
"tags": {
"owner": "v-aswmoh",
"ReleaseName": "Z3"
},
"location": "East US",
"etag": "AAAAAAAWN/4=",
"properties": {
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2021-06-16T09:40:00.9453556Z",
"frontend": {
"defaultHostname": "example-gateway.eastus.gateway.azure-api.net"
},
"backend": {
"subnet": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
}
},
"configurationApi": {
"hostname": "example-gateway.eastus.configuration.gateway.azure-api.net"
}

@tomkerkhove Tom Kerkhove (tomkerkhove) Dec 5, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if we should keep showing this, if we can let's drop it

@halspang halspang Dec 5, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a good rule of thumb for which APIs should return it and which should not?

},
"sku": {
"name": "WorkspaceGatewayPremium",
"capacity": 1
},
"kind": "KubernetesManaged",
"systemData": {
"createdBy": "string",
"createdByType": "User",
"createdAt": "2021-06-16T09:40:00.7106733Z",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-20T06:33:09.6159006Z"
}
}
}
}
}

27 changes: 27 additions & 0 deletions ...ement/preview/2024-10-01-preview/examples/ApiManagementGetKubernetesManagedWorkspace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"parameters": {
"serviceName": "apimService1",
"resourceGroupName": "rg1",
"api-version": "2024-10-01-preview",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"workspaceId": "wks1"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1",
"type": "Microsoft.ApiManagement/service/workspaces",
"name": "wks1",
"kind": "KubernetesManaged",
"properties": {
"provisioningState": "Succeeded",
Comment thread
halspang marked this conversation as resolved.
Outdated
"description": "workspace 1",
"displayName": "my workspace",
"configurationApi": {
"hostname": "example.eastus.configuration.gateway.azure-api.net"
Comment thread
halspang marked this conversation as resolved.
Outdated
}
}
}
}
}
}
Loading