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

Migrate GitHub.Network API spec to public repo. #30837

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import "@azure-tools/typespec-azure-core";
import "@azure-tools/typespec-azure-resource-manager";
import "@azure-tools/typespec-client-generator-core";
import "@typespec/openapi";
import "@typespec/rest";
import "./models.tsp";

using TypeSpec.Rest;
using Azure.ResourceManager;
using Azure.ResourceManager.Foundations;
using TypeSpec.Http;
using TypeSpec.OpenAPI;

namespace GitHub.Network;

@doc("GitHub.Network networkSettings resource. Represents the network settings needed for vnet injection.")
@includeInapplicableMetadataInPayload(false)
model NetworkSettingsResource
is Azure.ResourceManager.TrackedResource<NetworkSettingsResourceProperties> {
@doc("Name of the GitHub.Network resource")
@pattern("^[a-zA-Z0-9]")
@path
@key("networkSettingsName")
@segment("networkSettings")
@visibility("read")
name: string;
}

@armResourceOperations
interface NetworkSettingsResources {
@doc("Retrieves the properties of a GitHub.Network networkSettings resource.")
get is ArmResourceRead<NetworkSettingsResource>;

@doc("Creates a GitHub.Network networkSettings resource with the specified create parameters.")
create is ArmResourceCreateOrReplaceSync<NetworkSettingsResource>;

@doc("Updates the properties of an existing GitHub.Network networkSettings resource with the specified update parameters.")
update is ArmResourcePatchSync<
NetworkSettingsResource,
NetworkSettingsResourceProperties
>;

@doc("Deletes an existing GitHub.Network networkSettings resource.")
delete is ArmResourceDeleteSync<NetworkSettingsResource>;

@doc("Retrieves the properties of all GitHub.Network networkSettings resources.")
listByResourceGroup is ArmResourceListByParent<NetworkSettingsResource>;

@doc("Retrieves the properties of all GitHub.Network networkSettings resources.")
listBySubscription is ArmListBySubscription<NetworkSettingsResource>;
}

@@doc(NetworkSettingsResources.create::parameters.resource,
"GitHub.Network networkSettings resource create parameters."
);
@@Azure.ClientGenerator.Core.clientName(NetworkSettingsResources.create::parameters.resource,
"networkSettings"
);

@@doc(NetworkSettingsResources.update::parameters.properties,
"Parameters for updating the properties of the GitHub.Network resource."
);
@@Azure.ClientGenerator.Core.clientName(NetworkSettingsResources.update::parameters.properties,
"networkSettings"
);

@@Azure.ClientGenerator.Core.clientName(NetworkSettingsResources,
"networkSettings"
);
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"parameters": {
"api-version": "2024-04-01-preview",
"networkSettings": {
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
},
"tags": {}
},
"networkSettingsName": "networkSettings",
"resourceGroupName": "resourceGroup",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"name": "networkSettings",
"type": "GitHub.Network/networkSettings",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/resourceGroups/resourceGroup/GitHub.Network/networkSettings/networkSettings",
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
},
"tags": {}
}
},
"201": {
"body": {
"name": "networkSettings",
"type": "GitHub.Network/networkSettings",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/resourceGroups/resourceGroup/GitHub.Network/networkSettings/networkSettings",
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
},
"tags": {}
}
}
},
"operationId": "NetworkSettings_Create",
"title": "networkSettingsCreate"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"parameters": {
"api-version": "2024-04-01-preview",
"networkSettingsName": "networkSettings",
"resourceGroupName": "resourceGroup",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {},
"204": {}
},
"operationId": "NetworkSettings_Delete",
"title": "networkSettingsDelete"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"parameters": {
"api-version": "2024-04-01-preview",
"location": "eastus",
"networkSettingsName": "networkSettings",
"resourceGroupName": "resourceGroup",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"name": "networkSettings",
"type": "GitHub.Network/networkSettings",
"id": "/subscriptions/000000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/GitHub.Network/networkSettings/networkSettings",
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/000000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
},
"tags": {}
}
}
},
"operationId": "NetworkSettings_Get",
"title": "networkSettingsGet"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"parameters": {
"api-version": "2024-04-01-preview",
"resourceGroupName": "resourceGroup",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "networkSettings",
"type": "GitHub.Network/networkSettings",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/resourceGroups/resourceGroup/GitHub.Network/networkSettings/networkSettings",
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
}
}
]
}
}
},
"operationId": "NetworkSettings_ListByResourceGroup",
"title": "networkSettingsListGet"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"parameters": {
"api-version": "2024-04-01-preview",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "networkSettings",
"type": "GitHub.Network/networkSettings",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/GitHub.Network/networkSettings/networkSettings",
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
}
}
]
}
}
},
"operationId": "NetworkSettings_ListBySubscription",
"title": "networkSettingsListBySub"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"parameters": {
"api-version": "2024-04-01-preview",
"networkSettings": {
"tags": {
"tagName": "tagValue"
}
},
"networkSettingsName": "networkSettings",
"resourceGroupName": "resourceGroup",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"name": "networkSettings",
"type": "GitHub.Network/networkSettings",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/GitHub.Network/networkSettings/networkSettings",
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
},
"tags": {
"tagName": "tagValue"
}
}
}
},
"operationId": "NetworkSettings_Update",
"title": "networkSettingsUpdate"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"parameters": {
"api-version": "2024-04-01-preview"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "GitHub.Network/networkSettings/read",
"display": {
"provider": "GitHub.Network",
"resource": "networkSettings",
"operation": "Manage GitHub.Network resource",
"description": "View the properties of a GitHub.Network resource."
}
}
]
}
}
},
"operationId": "Operations_List",
"title": "operationsList"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"parameters": {
"api-version": "2024-04-01",
"networkSettings": {
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
},
"tags": {}
},
"networkSettingsName": "networkSettings",
"resourceGroupName": "resourceGroup",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"name": "networkSettings",
"type": "GitHub.Network/networkSettings",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/resourceGroups/resourceGroup/GitHub.Network/networkSettings/networkSettings",
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
},
"tags": {}
}
},
"201": {
"body": {
"name": "networkSettings",
"type": "GitHub.Network/networkSettings",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/resourceGroups/resourceGroup/GitHub.Network/networkSettings/networkSettings",
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
},
"tags": {}
}
}
},
"operationId": "NetworkSettings_Create",
"title": "networkSettingsCreate"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"parameters": {
"api-version": "2024-04-01",
"networkSettingsName": "networkSettings",
"resourceGroupName": "resourceGroup",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {},
"204": {}
},
"operationId": "NetworkSettings_Delete",
"title": "networkSettingsDelete"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"parameters": {
"api-version": "2024-04-01",
"location": "eastus",
"networkSettingsName": "networkSettings",
"resourceGroupName": "resourceGroup",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"name": "networkSettings",
"type": "GitHub.Network/networkSettings",
"id": "/subscriptions/000000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/GitHub.Network/networkSettings/networkSettings",
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/000000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
},
"tags": {}
}
}
},
"operationId": "NetworkSettings_Get",
"title": "networkSettingsGet"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"parameters": {
"api-version": "2024-04-01",
"resourceGroupName": "resourceGroup",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "networkSettings",
"type": "GitHub.Network/networkSettings",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/resourceGroups/resourceGroup/GitHub.Network/networkSettings/networkSettings",
"location": "eastus",
"properties": {
"businessId": "GitHub",
"subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet"
}
}
]
}
}
},
"operationId": "NetworkSettings_ListByResourceGroup",
"title": "networkSettingsListGet"
}
Loading