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

AzureStackHub FabricLocation new API #18323

Merged
merged 3 commits into from
Apr 22, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,236 @@
{
"swagger": "2.0",
"info": {
"description": "Fabric location operation endpoints and objects.",
"title": "FabricAdminClient",
"version": "2022-03-01"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{fabricLocation}": {
"get": {
"x-ms-examples": {
"Returns the requested fabric location.": {
"$ref": "./examples/FabricLocation/Get.json"
}
},
"tags": [
"FabricLocations"
],
"description": "Returns the requested fabric location.",
"operationId": "FabricLocations_Get",
"parameters": [
{
"$ref": "../../preview/2016-05-01/Fabric.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../preview/2016-05-01/Fabric.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "#/parameters/FabricLocationParameter"
},
{
"$ref": "../../preview/2016-05-01/Fabric.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FabricLocation"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations": {
"get": {
"x-ms-examples": {
"Returns a list of all fabric locations.": {
"$ref": "./examples/FabricLocation/List.json"
}
},
"tags": [
"FabricLocations"
],
"description": "Returns a list of all fabric locations.",
"operationId": "FabricLocations_List",
"parameters": [
{
"$ref": "../../preview/2016-05-01/Fabric.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../preview/2016-05-01/Fabric.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "../../preview/2016-05-01/Fabric.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../preview/2016-05-01/Fabric.json#/parameters/FilterParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FabricLocationList"
}
},
"default": {
"description": "Error Response.",
"schema": {
Copy link
Member

@rkmanda rkmanda Mar 29, 2022

Choose a reason for hiding this comment

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

Waiting on resolution of breaking change #Resolved

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Waiting on resolution of breaking change

The breaking change has been approved: https://msazure.visualstudio.com/One/_workitems/edit/13953702

"$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-odata": "#/definitions/FabricLocation"
}
}
},
"definitions": {
"FabricLocation": {
"description": "Fabric Location resource.",
"type": "object",
"properties": {
"properties": {
"description": "Properties of a FabricLocation.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/FabricLocationModel"
}
},
"allOf": [
{
"$ref": "../../preview/2016-05-01/Fabric.json#/definitions/Resource"
Copy link
Member

Choose a reason for hiding this comment

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

../../preview/2016-05-01

This doesn't block ARM signoff, but it's generally a better practice to not have API v2 reference files from API v1. You could just copy the Fabric.json file forward.

}
]
},
"FabricLocationModel": {
"description": "All properties of a fabric location resource.",
"type": "object",
"properties": {
"pepIpAddresses": {
"description": "The IP addresses of the privileged endpoints.",
"type": "array",
"items": {
"type": "string"
}
},
"timeServer": {
"description": "The IP address of the time server.",
"type": "string"
},
"stampInformationId": {
"description": "The deployment id of the stamp.",
"type": "string"
},
"stampCloudId": {
"description": "The cloud id of the stamp.",
"type": "string"
},
"externalDNSIPAddress01": {
"description": "First external IP address of the DNS server.",
"type": "string"
},
"externalDNSIPAddress02": {
"description": "Second external IP Address of the DNS server.",
"type": "string"
},
"exclusiveAdminOperationRunning": {
"description": "Value for whether an exclusive admin operation is running.",
"type": "boolean"
},
"exclusiveAdminOperationName": {
"description": "Name of the running exclusive admin operation.",
"type": "string"
},
"startUpActionPlanStartTime": {
"description": "Last known stamp start time for the start up action plan.",
"type": "string",
"format": "date-time"
},
"startUpActionPlanEndTime": {
"description": "Last known stamp stop time for the start up action plan.",
"type": "string",
"format": "date-time"
},
"shutDownActionPlanStartTime": {
"description": "Last known stamp start time for the shut down action plan",
"type": "string",
"format": "date-time"
},
"shutDownActionPlanEndTime": {
"description": "Last known stamp stop time for the shut down action plan.",
"type": "string",
"format": "date-time"
},
"dataGeoLocation": {
"description": "Data storage geo location for compliance.",
"type": "string"
}
}
},
"FabricLocationList": {
"description": "Pageable list of fabric locations.",
"type": "object",
"properties": {
"value": {
"description": "List of fabric locations.",
"type": "array",
"items": {
"$ref": "#/definitions/FabricLocation"
}
},
"nextLink": {
"description": "URI to the next page.",
"type": "string"
}
}
}
},
"parameters": {
"FabricLocationParameter": {
"description": "Fabric location.",
"name": "fabricLocation",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
}
},
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Authorization uses an Azure Active Directory OAuth2 flow.",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"parameters": {
"api-version": "2022-03-01",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"resourceGroupName": "System.local",
"fabricLocation": "local"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local",
"name": "local",
"type": "Microsoft.Fabric.Admin/fabricLocations",
"location": "local",
"tags": {},
"properties": {
"pepIpAddresses": [
"192.168.200.224",
"192.168.200.225",
"192.168.200.226"
],
"timeServer": "10.221.192.41",
"stampInformationId": "25c08b46-523c-4678-9cbc-9a5dd4406683",
"stampCloudId": "66be2306-27d2-4223-9d52-f49db5530a53",
"externalDNSIPAddress01": "192.168.102.10",
"externalDNSIPAddress02": "192.168.102.12",
"exclusiveAdminOperationRunning": true,
"exclusiveAdminOperationName": "MAS Update",
"startUpActionPlanStartTime": "2022-03-01T13:25:59.99999999Z",
"startUpActionPlanEndTime": "2022-03-01T13:59:59.99999999Z",
"shutDownActionPlanStartTime": "2022-03-01T10:15:59.99999999Z",
"shutDownActionPlanEndTime": "2022-03-01T10:30:59.99999999Z",
"dataGeoLocation": "europe"
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"parameters": {
"api-version": "2022-03-01",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"resourceGroupName": "System.local"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local",
"name": "local",
"type": "Microsoft.Fabric.Admin/fabricLocations",
"location": "local",
"tags": {},
"properties": {
"pepIpAddresses": [
"192.168.200.224",
"192.168.200.225",
"192.168.200.226"
],
"timeServer": "10.221.192.41",
"stampInformationId": "25c08b46-523c-4678-9cbc-9a5dd4406683",
"stampCloudId": "66be2306-27d2-4223-9d52-f49db5530a53",
"externalDNSIPAddress01": "192.168.102.10",
"externalDNSIPAddress02": "192.168.102.12",
"exclusiveAdminOperationRunning": true,
"exclusiveAdminOperationName": "MAS Update",
"startUpActionPlanStartTime": "2022-03-01T13:25:59.99999999Z",
"startUpActionPlanEndTime": "2022-03-01T13:59:59.99999999Z",
"shutDownActionPlanStartTime": "2022-03-01T10:15:59.99999999Z",
"shutDownActionPlanEndTime": "2022-03-01T10:30:59.99999999Z",
"dataGeoLocation": "europe"
}
}
]
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ These are the global settings for the Fabric API.
title: FabricAdminClient
description: Fabric Admin Client
openapi-type: arm
tag: package-2019-05-01
tag: package-2022-03-01
```

``` yaml
Expand All @@ -34,7 +34,6 @@ input-file:
- $(this-folder)/Microsoft.Fabric.Admin/preview/2016-05-01/Fabric.json
- $(this-folder)/Microsoft.Fabric.Admin/preview/2016-05-01/EdgeGateway.json
- $(this-folder)/Microsoft.Fabric.Admin/preview/2016-05-01/EdgeGatewayPool.json
- $(this-folder)/Microsoft.Fabric.Admin/preview/2016-05-01/FabricLocation.json
- $(this-folder)/Microsoft.Fabric.Admin/preview/2016-05-01/FileShare.json
- $(this-folder)/Microsoft.Fabric.Admin/preview/2016-05-01/InfraRole.json
- $(this-folder)/Microsoft.Fabric.Admin/preview/2016-05-01/InfraRoleInstance.json
Expand All @@ -53,6 +52,7 @@ input-file:
- $(this-folder)/Microsoft.Fabric.Admin/preview/2019-05-01/NasCluster.json"
- $(this-folder)/Microsoft.Fabric.Admin/preview/2020-10-01/ScaleUnit.json"
- $(this-folder)/Microsoft.Fabric.Admin/preview/2020-10-01/ScaleUnitNode.json"
- $(this-folder)/Microsoft.Fabric.Admin/stable/2022-03-01/FabricLocation.json
```

---
Expand Down
34 changes: 32 additions & 2 deletions specification/azsadmin/resource-manager/fabric/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ These are the global settings for the Fabric API.
title: FabricAdminClient
description: Fabric Admin Client
openapi-type: arm
tag: package-2019-05-01
tag: package-2022-03-01
```

### Tag: package-2016-05-01
Expand Down Expand Up @@ -117,6 +117,36 @@ input-file:
- "Microsoft.Fabric.Admin/preview/2020-10-01/ScaleUnitNode.json"
```

### Tag: package-2022-03-01

These settings apply only when `--tag=package-2022-03-01` is specified on the command line.

``` yaml $(tag) == 'package-2022-03-01'
input-file:
- "Microsoft.Fabric.Admin/preview/2016-05-01/ApplicationOperationResults.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/Fabric.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/EdgeGateway.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/EdgeGatewayPool.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/FileShare.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/InfraRole.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/InfraRoleInstance.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/IpPool.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/LogicalNetwork.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/LogicalSubnet.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/MacAddressPool.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/NetworkOperationResults.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/SlbMuxInstance.json"
- "Microsoft.Fabric.Admin/preview/2016-05-01/StorageOperationResults.json"
- "Microsoft.Fabric.Admin/preview/2018-10-01/StorageSubSystem.json"
- "Microsoft.Fabric.Admin/preview/2019-05-01/Drive.json"
- "Microsoft.Fabric.Admin/preview/2019-05-01/Volume.json"
- "Microsoft.Fabric.Admin/preview/2019-05-01/NasCluster.json"
- "Microsoft.Fabric.Admin/preview/2020-10-01/ComputeOperationResults.json"
- "Microsoft.Fabric.Admin/preview/2020-10-01/ScaleUnit.json"
- "Microsoft.Fabric.Admin/preview/2020-10-01/ScaleUnitNode.json"
- "Microsoft.Fabric.Admin/stable/2022-03-01/FabricLocation.json"
```

## Suppression
``` yaml
directive:
Expand Down Expand Up @@ -190,7 +220,7 @@ input-file:
- $(this-folder)/Microsoft.Fabric.Admin/preview/2020-10-01/ScaleUnit.json
- $(this-folder)/Microsoft.Fabric.Admin/preview/2020-10-01/ScaleUnitNode.json
- $(this-folder)/Microsoft.Fabric.Admin/preview/2020-10-01/ComputeOperationResults.json

- $(this-folder)/Microsoft.Fabric.Admin/stable/2022-03-01/FabricLocation.json
```

If there are files that should not be in the `all-api-versions` set,
Expand Down