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

Relay: adding new API version 2018-preview #8903

Merged
merged 10 commits into from
Apr 14, 2020
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
{
"swagger": "2.0",
"info": {
"title": "Relay API",
"description": "Use these API to manage Azure Relay resources through Azure Resource Manager.",
"version": "2018-01-01-preview",
"x-ms-code-generation-settings": {
"name": "RelayManagementClient"
}
},
"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.EventHub/namespaces/{namespaceName}/networkRuleSets/default": {
"put": {
"tags": [
"Namespaces"
],
"x-ms-examples": {
"NameSpaceNetworkRuleSetCreate": {
"$ref": "./examples/NameSpaces/VirtualNetworkRule/RelayNetworkRuleSetCreate.json"
}
},
"operationId": "Namespaces_CreateOrUpdateNetworkRuleSet",
"description": "Create or update NetworkRuleSet for a Namespace.",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/namespaceNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/NetworkRuleSet"
},
"description": "The Namespace IpFilterRule."
}
],
"responses": {
"200": {
"description": "Namespace NetworkRuleSet successfully returned.",
"schema": {
"$ref": "#/definitions/NetworkRuleSet"
}
},
"default": {
"description": "ServiceBus error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"get": {
"tags": [
"Namespaces"
],
"x-ms-examples": {
"NameSpaceNetworkRuleSetGet": {
"$ref": "./examples/NameSpaces/VirtualNetworkRule/RelayNetworkRuleSetGet.json"
}
},
"operationId": "Namespaces_GetNetworkRuleSet",
"description": "Gets NetworkRuleSet for a Namespace.",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/namespaceNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Namespace NetworkRuleSet successfully returned.",
"schema": {
"$ref": "#/definitions/NetworkRuleSet"
}
},
"default": {
"description": "ServiceBus error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"Resource": {
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "Resource ID."
},
"name": {
"readOnly": true,
"type": "string",
"description": "Resource name."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Resource type."
}
},
"description": "The resource definition.",
"x-ms-azure-resource": true
},
"ErrorResponse": {
"description": "Error response indicates Relay service is not able to process the incoming request. The reason is provided in the error message.",
"type": "object",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message indicating why the operation failed.",
"type": "string"
}
}
},
"NWRuleSetIpRules": {
"x-ms-client-flatten": true,
"properties": {
"ipMask": {
"type": "string",
"description": "IP Mask"
},
"action": {
"type": "string",
"description": "The IP Filter Action",
"enum": [
"Allow"
v-Ajnava marked this conversation as resolved.
Show resolved Hide resolved
],
"x-ms-enum": {
"name": "NetworkRuleIPAction",
"modelAsString": true
}
}
},
"description": "The response from the List namespace operation."
},
"NetworkRuleSet": {
"properties": {
"properties": {
"description": "NetworkRuleSet properties",
"x-ms-client-flatten": true,
"properties": {
"defaultAction": {
"type": "string",
"description": "Default Action for Network Rule Set",
"enum": [
"Allow",
"Deny"
],
"x-ms-enum": {
"name": "DefaultAction",
"modelAsString": true
}
},
"ipRules": {
"type": "array",
"items": {
"$ref": "#/definitions/NWRuleSetIpRules"
},
"description": "List of IpRules"
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"description": "Description of topic resource."
}
},
"parameters": {
"subscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
"required": true,
"type": "string",
"description": "Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
},
"apiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "Client API version."
},
"resourceGroupNameParameter": {
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 90,
"x-ms-parameter-location": "method",
"description": "Name of the Resource group within the Azure subscription."
},
"namespaceNameParameter": {
"name": "namespaceName",
"in": "path",
"required": true,
"type": "string",
"minLength": 6,
"maxLength": 50,
"x-ms-parameter-location": "method",
"description": "The namespace name"
}
}
}
Loading