diff --git a/custom-words.txt b/custom-words.txt index c748372dcab1..92f428fae03a 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2239,3 +2239,4 @@ XLSM DOCM multislot Tebibytes +privatelinkservicesforpowerbi diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/Operations_List.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/Operations_List.json new file mode 100644 index 000000000000..417d6feb12a1 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/Operations_List.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/read", + "display": { + "description": "Gets all resources for the tenant private link service", + "operation": "Gets all resources", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/operationResults/operationId/read", + "display": { + "description": "Gets operation result of Private Link Service Resources for Power BI.", + "operation": "Get Operation Result", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/read", + "display": { + "description": "Gets resources for the tenant private link service by name", + "operation": "Gets resource by name", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/write", + "display": { + "description": "Creates or updates resource for the tenant private link service", + "operation": "Creates or updates private link service", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/delete", + "display": { + "description": "Deletes resource for the tenant private link service", + "operation": "Deletes private link service", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateLinkResources/read", + "display": { + "description": "Gets private link resources in a Azure resource", + "operation": "Gets private link resources by name", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnectionProxies/privateEndpointName.privateEndpointGuid/read", + "display": { + "description": "Gets private endpoint connection proxy for the tenant", + "operation": "Gets private endpoint connection proxy", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnectionProxies/privateEndpointName.privateEndpointGuid/write", + "display": { + "description": "Creates or updates private endpoint connection proxy for the tenant", + "operation": "Creates or updates private endpoint connection proxy", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnectionProxies/privateEndpointName.privateEndpointGuid/delete", + "display": { + "description": "Deletes private endpoint connection proxy for the tenant", + "operation": "Deletes private endpoint connection proxy", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnectionProxies/privateEndpointName.privateEndpointGuid/validate/action", + "display": { + "description": "Validates a private endpoint connection proxy before create or update", + "operation": "Validates a private endpoint connection proxy", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/privateEndpointName.privateEndpointGuid/read", + "display": { + "description": "Gets private endpoint connection for the tenant", + "operation": "Gets private endpoint connection", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/privateEndpointName.privateEndpointGuid/write", + "display": { + "description": "Creates or updates private endpoint connection for the tenant", + "operation": "Creates or updates private endpoint connection", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + }, + { + "name": "Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/privateEndpointName.privateEndpointGuid/delete", + "display": { + "description": "Deletes private endpoint connection for the tenant", + "operation": "Deletes private endpoint connection", + "resource": "Private link service resources", + "provider": "Microsoft Power BI" + } + } + ] + } + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Create.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Create.json new file mode 100644 index 000000000000..ba0e6e6c9535 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Create.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "azureResourceName": "azureResourceName", + "api-version": "2020-06-01", + "x-ms-client-tenant-id": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f", + "body": { + "location": "global", + "properties": { + "tenantId": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myPrivateLinkServiceResource", + "location": "global", + "properties": { + "tenantId": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "201": { + "body": { + "name": "myPrivateLinkServiceResource", + "location": "global", + "properties": { + "tenantId": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Delete.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Delete.json new file mode 100644 index 000000000000..979741ac1625 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "azureResourceName": "azureResourceName", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "description": "OK", + "headers": {} + }, + "204": { + "description": "No Content." + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_ListByResourceName.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_ListByResourceName.json new file mode 100644 index 000000000000..ceac97bbc525 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_ListByResourceName.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "azureResourceName": "azureResourceName", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": [ + { + "name": "conection 1", + "location": "west us", + "properties": { + "tenantId": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f", + "privateEndpointConnections": [ + { + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointConnection.58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "name": "myPrivateEndpointConnection", + "type": "string", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "My private endpoint connection", + "actionsRequired": "None" + } + } + } + ] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + ] + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Update.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Update.json new file mode 100644 index 000000000000..ba0e6e6c9535 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "azureResourceName": "azureResourceName", + "api-version": "2020-06-01", + "x-ms-client-tenant-id": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f", + "body": { + "location": "global", + "properties": { + "tenantId": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myPrivateLinkServiceResource", + "location": "global", + "properties": { + "tenantId": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "201": { + "body": { + "name": "myPrivateLinkServiceResource", + "location": "global", + "properties": { + "tenantId": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Create.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Create.json new file mode 100644 index 000000000000..44aef5376784 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Create.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "azureResourceName": "azureResourceName", + "privateEndpointName": "myPrivateEndpointName", + "privateEndpointGuid": "58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "api-version": "2020-06-01", + "privateEndpointConnection": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved ", + "description": "", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "name": "myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "type": "Microsoft.PowerBI/privateLinkServicesForPowerBI/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved ", + "description": "", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "name": "myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "type": "Microsoft.PowerBI/privateLinkServicesForPowerBI/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved ", + "description": "", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Delete.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..8741f9970798 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Delete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "azureResourceName": "azureResourceName", + "privateEndpointName": "myPrivateEndpointName", + "privateEndpointGuid": "58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "api-version": "2020-06-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "40f12aac-47a9-49f0-b0a8-c9367edca7b0" + } + }, + "200": { + "headers": {} + }, + "204": {} + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Get.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..6fced254fd19 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "azureResourceName": "azureResourceName", + "privateEndpointName": "myPrivateEndpointName", + "privateEndpointGuid": "58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "name": "myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "type": "Microsoft.PowerBI/privateLinkServicesForPowerBI/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "please approve", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_ListByResource.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_ListByResource.json new file mode 100644 index 000000000000..a42c728b145b --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_ListByResource.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "azureResourceName": "azureResourceName", + "privateEndpointName": "myPrivateEndpointName", + "privateEndpointGuid": "58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Test", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "name": "myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721", + "type": "Microsoft.PowerBI/privateLinkServicesForPowerBI/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkResources_Get.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkResources_Get.json new file mode 100644 index 000000000000..c93cd1e37da5 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkResources_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "azureResourceName": "azureResourceName", + "privateLinkResourceName": "tenant", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateLinkResources/tenant", + "name": "tenant", + "type": "Microsoft.PowerBI/{resourceType}/privateLinkResources", + "properties": { + "groupId": "tenant", + "requiredMembers": [ + "tenant", + "capacity:3df897a4f10b49e9bddb0e9cf062adba" + ], + "requiredZoneNames": [ + "privatelink.powerbi.com" + ] + } + } + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkResources_ListByResource.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkResources_ListByResource.json new file mode 100644 index 000000000000..c17f8c290628 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkResources_ListByResource.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "azureResourceName": "azureResourceName", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateLinkResources/tenant", + "name": "tenant", + "type": "Microsoft.PowerBI/{resourceType}/privateLinkResources", + "properties": { + "groupId": "tenant", + "requiredMembers": [ + "tenant", + "capacity:3df897a4f10b49e9bddb0e9cf062adba" + ], + "requiredZoneNames": [ + "privatelink.powerbi.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServiceResourceOperationResults_Get.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServiceResourceOperationResults_Get.json new file mode 100644 index 000000000000..d17efeda2c19 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServiceResourceOperationResults_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "operationId": "9a062a88-e463-4697-bef2-fe039df73a02", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "name": "9a062a88-e463-4697-bef2-fe039df73a02", + "status": "InProgress", + "startTime": "2017-01-06T18:58:24.7596323+00:00" + } + }, + "202": { + "body": { + "name": "9a062a88-e463-4697-bef2-fe039df73a02", + "status": "InProgress", + "startTime": "2017-01-06T18:58:24.7596323+00:00" + } + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServices_ListByResourceGroup.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServices_ListByResourceGroup.json new file mode 100644 index 000000000000..8f2253595701 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServices_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "resourceGroupName": "resourceGroup", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": [ + { + "name": "conection 1", + "location": "west us", + "properties": { + "tenantId": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f", + "privateEndpointConnections": [ + { + "id": "1001", + "name": "myPrivateEndpointConnections", + "type": "string", + "properties": { + "privateEndpoint": { + "id": "myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "My private endpoint connection", + "actionsRequired": "None" + } + } + } + ] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + ] + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServices_ListBySubscriptionId.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServices_ListBySubscriptionId.json new file mode 100644 index 000000000000..ca21fd0c664d --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServices_ListBySubscriptionId.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "a0020869-4d28-422a-89f4-c2413130d73c", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": [ + { + "name": "conection 1", + "location": "west us", + "properties": { + "tenantId": "ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f", + "privateEndpointConnections": [ + { + "id": "1001", + "name": "myPrivateEndpointConnections", + "type": "string", + "properties": { + "privateEndpoint": { + "id": "myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "My private endpoint connection", + "actionsRequired": "None" + } + } + } + ] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + ] + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/powerbiprivatelinks.json b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/powerbiprivatelinks.json new file mode 100644 index 000000000000..a73a6380f793 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/powerbiprivatelinks.json @@ -0,0 +1,1183 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-06-01", + "title": "PrivateLinkServicesForPowerBIClient", + "description": "Client to manage Power BI Private Link Service resources and connection members." + }, + "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": { + "/providers/Microsoft.PowerBI/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Power BI RP operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Lists all of the available Power BI RP operations": { + "$ref": "./examples/Operations_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "x-ms-examples": { + "List private link resources in a subscription": { + "$ref": "./examples/PrivateLinkServices_ListBySubscriptionId.json" + } + }, + "operationId": "privateLinkServicesForPowerBI_ListBySubscriptionId", + "description": "Gets all the private link resources for the given subscription id.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TenantResource" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/operationResults/{operationId}": { + "get": { + "tags": [ + "PrivateLinkServiceResourceOperationResults" + ], + "description": "Gets operation result of Private Link Service Resources for Power BI.", + "operationId": "PrivateLinkServiceResourceOperationResults_Get", + "x-ms-examples": { + "Result of operation on private link resources": { + "$ref": "./examples/PrivateLinkServiceResourceOperationResults_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AsyncOperationDetail" + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "#/definitions/AsyncOperationDetail" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListByResourceGroup", + "x-ms-examples": { + "List private link resources in a resource group": { + "$ref": "./examples/PrivateLinkServices_ListByResourceGroup.json" + } + }, + "description": "Gets all the private link resources for the given resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TenantResource" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}": { + "get": { + "tags": [ + "PowerBIResources" + ], + "operationId": "PowerBIResources_ListByResourceName", + "x-ms-examples": { + "List private link resources in a Azure resource": { + "$ref": "./examples/PowerBIResources_ListByResourceName.json" + } + }, + "description": "Gets all the private link resources for the given Azure resource.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TenantResource" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + } + }, + "put": { + "tags": [ + "PowerBIResources" + ], + "operationId": "PowerBIResources_Create", + "x-ms-examples": { + "Creates or updates private link service resource": { + "$ref": "./examples/PowerBIResources_Create.json" + } + }, + "description": "Creates or updates a Private Link Service Resource for Power BI.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientTenantIdHeaderParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "description": "Tenant resource to be created or updated.", + "schema": { + "$ref": "#/definitions/TenantResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "$ref": "#/definitions/TenantResource" + }, + "headers": {} + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/TenantResource" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + } + }, + "patch": { + "tags": [ + "PowerBIResources" + ], + "operationId": "PowerBIResources_Update", + "x-ms-examples": { + "Updates private link service resource": { + "$ref": "./examples/PowerBIResources_Update.json" + } + }, + "description": "Creates or updates a Private Link Service Resource for Power BI.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientTenantIdHeaderParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "description": "Tenant resource to be created or updated.", + "schema": { + "$ref": "#/definitions/TenantResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "$ref": "#/definitions/TenantResource" + }, + "headers": {} + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/TenantResource" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + } + }, + "delete": { + "tags": [ + "PowerBIResources" + ], + "operationId": "PowerBIResources_Delete", + "x-ms-examples": { + "Deletes private link service resource": { + "$ref": "./examples/PowerBIResources_Delete.json" + } + }, + "description": "Deletes a Private Link Service Resource for Power BI.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content." + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "summary": "List private link Power BI resource.", + "description": "List private link resources under a specific Power BI resource.", + "operationId": "PrivateLinkResources_ListByResource", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + }, + "x-ms-examples": { + "Gets private link resources in a Azure resource": { + "$ref": "./examples/PrivateLinkResources_ListByResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "summary": "Get a private link resource.", + "description": "Get properties of a private link resource.", + "operationId": "PrivateLinkResources_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureResourceNameParameter" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "The name of private link resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + }, + "x-ms-examples": { + "Gets a private link resource": { + "$ref": "./examples/PrivateLinkResources_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Lists all private endpoint connections under a resource.", + "description": "Gets private endpoint connection for Power BI.", + "operationId": "PrivateEndpointConnections_ListByResource", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "azureResourceName", + "in": "path", + "description": "The name of the powerbi resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of private endpoint connections in the private endpoint resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets private endpoint connections": { + "$ref": "./examples/PrivateEndpointConnections_ListByResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateEndpointConnections/{privateEndpointName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Get a specific private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "description": "Get a specific private endpoint connection for Power BI by private endpoint name.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureResourceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + }, + "x-ms-examples": { + "Gets private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Update a specific private endpoint connection.", + "description": "Updates the status of Private Endpoint Connection object. Used to approve or reject a connection.", + "operationId": "PrivateEndpointConnections_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureResourceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointNameParameter" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "required": true, + "description": "Private endpoint connection object to update.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + }, + "x-ms-examples": { + "Updates status of private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnections_Create.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection for Power BI by private endpoint name.", + "summary": "Asynchronous API to delete a private endpoint connection for Power BI by private endpoint name.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureResourceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The operation completed successfully." + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The Azure async operation id to poll on result." + } + } + }, + "204": { + "description": "No Content." + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "An error response received from Power BI service." + } + }, + "x-ms-examples": { + "Deletes private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnections_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "AsyncOperationDetail": { + "title": "AsyncOperationDetail", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The operation id." + }, + "name": { + "type": "string", + "description": "The operation name." + }, + "status": { + "type": "string", + "description": "The operation status." + }, + "startTime": { + "type": "string", + "description": "The operation start time." + }, + "endTime": { + "type": "string", + "description": "The operation end time." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail", + "description": "The error." + } + } + }, + "TenantResource": { + "title": "TenantResource", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Specifies the resource identifier of the resource." + }, + "name": { + "type": "string", + "description": "Specifies the name of the resource.", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Specifies the type of the resource." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TenantProperties", + "description": "Specifies the properties of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Specifies the tags of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TenantProperties": { + "title": "TenantProperties", + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Specifies the tenant id of the resource." + }, + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Specifies the private endpoint connections of the resource." + } + } + }, + "PrivateLinkConnectionDetail": { + "title": "PrivateLinkConnectionDetail", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Specifies the type of the connection detail." + }, + "memberName": { + "type": "string", + "description": "Specifies the member name of the connection detail." + }, + "privateIpAddress": { + "type": "string", + "description": "Specifies the private ip address of the connection detail." + }, + "linkIdentifier": { + "type": "string", + "description": "Specifies the link id of the connection detail." + }, + "groupId": { + "type": "string", + "description": "Specifies the group id of the connection detail." + } + } + }, + "GroupConnectivityInformation": { + "title": "GroupConnectivityInformation", + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "Specifies the group id of the group connectivity information." + }, + "memberName": { + "type": "string", + "description": "Specifies the member name of the group connectivity information." + }, + "internalFqdn": { + "type": "string", + "description": "Specifies the internal FQDN of the group connectivity information." + }, + "customerVisibleFqdns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the customer visible FQDNs of the group connectivity information." + }, + "privateLinkServiceArmRegion": { + "type": "string", + "description": "Specifies the ARM region of the group connectivity information." + } + } + }, + "ConnectionState": { + "description": "ConnectionState information.", + "type": "object", + "properties": { + "status": { + "description": "Status of the connection.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PersistedConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Description of the connection state.", + "type": "string" + }, + "actionsRequired": { + "description": "Actions required (if any).", + "type": "string" + } + } + }, + "PrivateLinkServiceProxy": { + "title": "PrivateLinkServiceProxy", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Specifies the id of the private link service proxy." + }, + "groupConnectivityInformation": { + "type": "array", + "items": { + "$ref": "#/definitions/GroupConnectivityInformation" + }, + "description": "Specifies the group connectivity information of the private link service proxy." + }, + "remotePrivateLinkServiceConnectionState": { + "$ref": "#/definitions/ConnectionState", + "description": "Specifies the connection state of the private link service proxy." + }, + "remotePrivateEndpointConnection": { + "$ref": "#/definitions/RemotePrivateEndpointConnection", + "description": "Specifies the private endpoint connection of the private link service proxy." + } + } + }, + "PrivateLinkServiceConnection": { + "title": "PrivateLinkServiceConnection", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Specifies the name of the private link service connection." + }, + "groupIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the group ids of the private link service connection." + }, + "requestMessage": { + "type": "string", + "description": "Specifies the request message of the private link service connection." + } + } + }, + "PrivateEndpointConnection": { + "title": "PrivateEndpointConnection", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Specifies the id of the resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Specifies the name of the resource." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Specifies the type of the resource." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Specifies the properties of the private endpoint connection." + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionListResult": { + "title": "PrivateEndpointConnections", + "description": "List of private endpoint connections.", + "type": "object", + "properties": { + "value": { + "title": "PrivateEndpointConnection", + "description": "Specifies the name of the private endpoint connection.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + } + }, + "PrivateEndpointConnectionProperties": { + "title": "PrivateEndpointConnectionProperties", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "Specifies the private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/ConnectionState", + "description": "Specifies the connection state." + }, + "provisioningState": { + "description": "Provisioning state of the Private Endpoint Connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceProvisioningState", + "modelAsString": true + } + } + } + }, + "ActionsRequired": { + "title": "ActionsRequired", + "type": "string", + "enum": [ + "None", + "Recreate" + ] + }, + "PrivateEndpoint": { + "title": "PrivateEndpoint", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Specifies the id of private endpoint." + } + } + }, + "PrivateLinkResourcesListResult": { + "title": "PrivateLinkResourcesListResult", + "description": "Specifies list of the private link resource.", + "type": "object", + "properties": { + "value": { + "description": "A collection of private endpoint connection resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string" + }, + "name": { + "description": "Name of the resource.", + "type": "string" + }, + "type": { + "description": "Type of the resource.", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "RemotePrivateEndpointConnection": { + "title": "RemotePrivateEndpointConnection", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Specifies the id of private endpoint connection." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "client" + }, + "AzureResourceNameParameter": { + "name": "azureResourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource.", + "x-ms-parameter-location": "client" + }, + "PrivateEndpointNameParameter": { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint.", + "x-ms-parameter-location": "client" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of Azure async operation.", + "x-ms-parameter-location": "client" + }, + "ClientTenantIdHeaderParameter": { + "name": "x-ms-client-tenant-id", + "in": "header", + "description": "The client tenant id in header. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": false, + "type": "string", + "x-ms-client-name": "ClientTenantId", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + } + } +} diff --git a/specification/powerbiprivatelinks/resource-manager/readme.az.md b/specification/powerbiprivatelinks/resource-manager/readme.az.md new file mode 100644 index 000000000000..6682ee2f922b --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/readme.az.md @@ -0,0 +1,28 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: powerbiprivatelinks + namespace: azure.mgmt.powerbiprivatelinks + package-name: azure-mgmt-powerbiprivatelinks +az-output-folder: $(azure-cli-extension-folder)/src/powerbiprivatelinks +python-sdk-output-folder: "$(az-output-folder)/azext_powerbiprivatelinks/vendored_sdks/powerbiprivatelinks" +# add additional configuration here specific for Azure CLI +# refer to the faq.md for more details +``` + + + +This is for command modules that already in azure cli main repo. +``` yaml $(az) && $(target-mode) == 'core' +az: + extensions: powerbiprivatelinks + namespace: azure.mgmt.powerbiprivatelinks + package-name: azure-mgmt-powerbiprivatelinks +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/powerbiprivatelinks +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/powerbiprivatelinks" +``` \ No newline at end of file diff --git a/specification/powerbiprivatelinks/resource-manager/readme.csharp.md b/specification/powerbiprivatelinks/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..761c8476d1ed --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.PowerBI + output-folder: $(csharp-sdks-folder)/powerbiprivatelinks/management/Microsoft.PowerBI/GeneratedProtocol +``` diff --git a/specification/powerbiprivatelinks/resource-manager/readme.go.md b/specification/powerbiprivatelinks/resource-manager/readme.go.md new file mode 100644 index 000000000000..17bff7f7ed79 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/powerbiprivatelinks/armpowerbiprivatelinks +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` diff --git a/specification/powerbiprivatelinks/resource-manager/readme.md b/specification/powerbiprivatelinks/resource-manager/readme.md new file mode 100644 index 000000000000..016db9095617 --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/readme.md @@ -0,0 +1,109 @@ +# powerbiprivatelinks + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for powerbiprivatelinks. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the Azure PowerBI API. + +```yaml +openapi-type: arm +tag: package-2020-06-01 +``` + +### Tag: package-2020-06-01 + +These settings apply only when `--tag=package-2020-06-01` is specified on the command line. + +```yaml $(tag) == 'package-2020-06-01' +input-file: + - Microsoft.PowerBI/stable/2020-06-01/powerbiprivatelinks.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go-track2 + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.powerbiprivatelinks +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-powerbiprivatelinks +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2020-06-01 +``` + +### Tag: package-2020-06-01 and java + +These settings apply only when `--tag=package-2020-06-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-06-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.powerbiprivatelinks.v2020-06-01 + output-folder: $(azure-libraries-for-java-folder)/sdk/powerbiprivatelinks/mgmt-v2020-06-01 +regenerate-manager: true +generate-interface: true +``` + +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/powerbiprivatelinks/resource-manager/readme.python.md b/specification/powerbiprivatelinks/resource-manager/readme.python.md new file mode 100644 index 000000000000..080807cc4d8f --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/readme.python.md @@ -0,0 +1,25 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.powerbiprivatelinks +package-name: azure-mgmt-powerbiprivatelinks +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/powerbiprivatelinks/azure-mgmt-powerbiprivatelinks/azure/mgmt/powerbiprivatelinks +``` + +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/powerbiprivatelinks/azure-mgmt-powerbiprivatelinks +``` diff --git a/specification/powerbiprivatelinks/resource-manager/readme.typescript.md b/specification/powerbiprivatelinks/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..e7ef4e0088ed --- /dev/null +++ b/specification/powerbiprivatelinks/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-powerbiprivatelinks" + output-folder: "$(typescript-sdks-folder)/sdk/powerbiprivatelinks/arm-powerbiprivatelinks" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +```